5 [Differences versus the previous schema version](apidocs/aai_swagger_v11.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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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: tenant-context
1005 description: This field will store the tenant context.
1008 - name: vserver-name
1010 description: Name of vserver
1013 - name: vserver-name2
1015 description: Alternative name of vserver
1020 description: Trigger for operational monitoring of this resource by Service Assurance systems.
1027 - name: is-closed-loop-disabled
1033 - CloudInfrastructure
1034 summary: create or update an existing volume
1036 Create or update an existing volume.
1038 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
1039 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1048 description: Response codes found in [response codes](https://wiki.onap.org/).
1052 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1055 example: __CLOUD-OWNER__
1056 - name: cloud-region-id
1058 description: Identifier used by the vendor for the region. Second part of composite key
1061 example: __CLOUD-REGION-ID__
1064 description: Unique id relative to the cloud-region.
1067 example: __TENANT-ID__
1070 description: Unique identifier for this vserver relative to its tenant
1073 example: __VSERVER-ID__
1076 description: Unique ID of block storage volume relative to the vserver.
1079 example: __VOLUME-ID__
1082 description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
1085 $ref: "#/definitions/volume"
1088 - CloudInfrastructure
1089 summary: update an existing volume
1091 Update an existing volume
1093 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1094 The PUT operation will entirely replace an existing object.
1095 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
1097 Other differences between PUT and PATCH are:
1099 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
1100 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1101 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1102 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1111 description: Response codes found in [response codes](https://wiki.onap.org/).
1115 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1118 example: __CLOUD-OWNER__
1119 - name: cloud-region-id
1121 description: Identifier used by the vendor for the region. Second part of composite key
1124 example: __CLOUD-REGION-ID__
1127 description: Unique id relative to the cloud-region.
1130 example: __TENANT-ID__
1133 description: Unique identifier for this vserver relative to its tenant
1136 example: __VSERVER-ID__
1139 description: Unique ID of block storage volume relative to the vserver.
1142 example: __VOLUME-ID__
1145 description: volume object that needs to be created or updated.
1148 $ref: "#/patchDefinitions/volume"
1151 - CloudInfrastructure
1152 summary: delete an existing volume
1153 description: delete an existing volume
1154 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1163 description: Response codes found in [response codes](https://wiki.onap.org/).
1167 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1170 example: __CLOUD-OWNER__
1171 - name: cloud-region-id
1173 description: Identifier used by the vendor for the region. Second part of composite key
1176 example: __CLOUD-REGION-ID__
1179 description: Unique id relative to the cloud-region.
1182 example: __TENANT-ID__
1185 description: Unique identifier for this vserver relative to its tenant
1188 example: __VSERVER-ID__
1191 description: Unique ID of block storage volume relative to the vserver.
1194 example: __VOLUME-ID__
1195 - name: resource-version
1197 description: resource-version for concurrency
1200 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
1203 - CloudInfrastructure
1204 summary: returns volumes
1205 description: returns volumes
1206 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
1212 description: successful operation
1214 $ref: "#/getDefinitions/volumes"
1216 description: Response codes found in [response codes](https://wiki.onap.org/).
1220 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1223 example: __CLOUD-OWNER__
1224 - name: cloud-region-id
1226 description: Identifier used by the vendor for the region. Second part of composite key
1229 example: __CLOUD-REGION-ID__
1232 description: Unique id relative to the cloud-region.
1235 example: __TENANT-ID__
1238 description: Unique identifier for this vserver relative to its tenant
1241 example: __VSERVER-ID__
1244 description: Type of the cloud (e.g., openstack)
1247 - name: owner-defined-type
1249 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1254 description: Readable name of tenant
1257 - name: tenant-context
1259 description: This field will store the tenant context.
1262 - name: vserver-name
1264 description: Name of vserver
1267 - name: vserver-name2
1269 description: Alternative name of vserver
1274 description: Trigger for operational monitoring of this resource by Service Assurance systems.
1281 - name: is-closed-loop-disabled
1285 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1288 - CloudInfrastructure
1289 summary: see node definition for valid relationships
1290 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1299 description: Response codes found in [response codes](https://wiki.onap.org/).
1303 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1306 example: __CLOUD-OWNER__
1307 - name: cloud-region-id
1309 description: Identifier used by the vendor for the region. Second part of composite key
1312 example: __CLOUD-REGION-ID__
1315 description: Unique id relative to the cloud-region.
1318 example: __TENANT-ID__
1321 description: Unique identifier for this vserver relative to its tenant
1324 example: __VSERVER-ID__
1327 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
1330 $ref: "#/definitions/relationship"
1333 - CloudInfrastructure
1334 summary: delete an existing relationship
1335 description: delete an existing relationship
1336 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1345 description: Response codes found in [response codes](https://wiki.onap.org/).
1349 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1352 example: __CLOUD-OWNER__
1353 - name: cloud-region-id
1355 description: Identifier used by the vendor for the region. Second part of composite key
1358 example: __CLOUD-REGION-ID__
1361 description: Unique id relative to the cloud-region.
1364 example: __TENANT-ID__
1367 description: Unique identifier for this vserver relative to its tenant
1370 example: __VSERVER-ID__
1371 /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:
1374 - CloudInfrastructure
1375 summary: see node definition for valid relationships
1376 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1385 description: Response codes found in [response codes](https://wiki.onap.org/).
1389 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1392 example: __CLOUD-OWNER__
1393 - name: cloud-region-id
1395 description: Identifier used by the vendor for the region. Second part of composite key
1398 example: __CLOUD-REGION-ID__
1401 description: Unique id relative to the cloud-region.
1404 example: __TENANT-ID__
1407 description: Unique identifier for this vserver relative to its tenant
1410 example: __VSERVER-ID__
1411 - name: interface-name
1413 description: Name given to the interface
1416 example: __INTERFACE-NAME__
1417 - name: vlan-interface
1419 description: String that identifies the interface
1422 example: __VLAN-INTERFACE__
1425 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
1428 $ref: "#/definitions/relationship"
1431 - CloudInfrastructure
1432 summary: delete an existing relationship
1433 description: delete an existing relationship
1434 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1443 description: Response codes found in [response codes](https://wiki.onap.org/).
1447 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1450 example: __CLOUD-OWNER__
1451 - name: cloud-region-id
1453 description: Identifier used by the vendor for the region. Second part of composite key
1456 example: __CLOUD-REGION-ID__
1459 description: Unique id relative to the cloud-region.
1462 example: __TENANT-ID__
1465 description: Unique identifier for this vserver relative to its tenant
1468 example: __VSERVER-ID__
1469 - name: interface-name
1471 description: Name given to the interface
1474 example: __INTERFACE-NAME__
1475 - name: vlan-interface
1477 description: String that identifies the interface
1480 example: __VLAN-INTERFACE__
1481 /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:
1484 - CloudInfrastructure
1485 summary: see node definition for valid relationships
1486 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1495 description: Response codes found in [response codes](https://wiki.onap.org/).
1499 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1502 example: __CLOUD-OWNER__
1503 - name: cloud-region-id
1505 description: Identifier used by the vendor for the region. Second part of composite key
1508 example: __CLOUD-REGION-ID__
1511 description: Unique id relative to the cloud-region.
1514 example: __TENANT-ID__
1517 description: Unique identifier for this vserver relative to its tenant
1520 example: __VSERVER-ID__
1521 - name: interface-name
1523 description: Name given to the interface
1526 example: __INTERFACE-NAME__
1527 - name: vlan-interface
1529 description: String that identifies the interface
1532 example: __VLAN-INTERFACE__
1533 - name: l3-interface-ipv4-address
1535 description: IP address
1538 example: __L3-INTERFACE-IPV4-ADDRESS__
1541 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1544 $ref: "#/definitions/relationship"
1547 - CloudInfrastructure
1548 summary: delete an existing relationship
1549 description: delete an existing relationship
1550 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1559 description: Response codes found in [response codes](https://wiki.onap.org/).
1563 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1566 example: __CLOUD-OWNER__
1567 - name: cloud-region-id
1569 description: Identifier used by the vendor for the region. Second part of composite key
1572 example: __CLOUD-REGION-ID__
1575 description: Unique id relative to the cloud-region.
1578 example: __TENANT-ID__
1581 description: Unique identifier for this vserver relative to its tenant
1584 example: __VSERVER-ID__
1585 - name: interface-name
1587 description: Name given to the interface
1590 example: __INTERFACE-NAME__
1591 - name: vlan-interface
1593 description: String that identifies the interface
1596 example: __VLAN-INTERFACE__
1597 - name: l3-interface-ipv4-address
1599 description: IP address
1602 example: __L3-INTERFACE-IPV4-ADDRESS__
1603 /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}:
1606 - CloudInfrastructure
1607 summary: returns l3-interface-ipv4-address-list
1608 description: returns l3-interface-ipv4-address-list
1609 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1615 description: successful operation
1617 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
1619 description: Response codes found in [response codes](https://wiki.onap.org/).
1623 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1626 example: __CLOUD-OWNER__
1627 - name: cloud-region-id
1629 description: Identifier used by the vendor for the region. Second part of composite key
1632 example: __CLOUD-REGION-ID__
1635 description: Unique id relative to the cloud-region.
1638 example: __TENANT-ID__
1641 description: Unique identifier for this vserver relative to its tenant
1644 example: __VSERVER-ID__
1645 - name: interface-name
1647 description: Name given to the interface
1650 example: __INTERFACE-NAME__
1651 - name: vlan-interface
1653 description: String that identifies the interface
1656 example: __VLAN-INTERFACE__
1657 - name: l3-interface-ipv4-address
1659 description: IP address
1662 example: __L3-INTERFACE-IPV4-ADDRESS__
1665 description: Type of the cloud (e.g., openstack)
1668 - name: owner-defined-type
1670 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1675 description: Readable name of tenant
1678 - name: tenant-context
1680 description: This field will store the tenant context.
1683 - name: vserver-name
1685 description: Name of vserver
1688 - name: vserver-name2
1690 description: Alternative name of vserver
1695 description: Trigger for operational monitoring of this resource by Service Assurance systems.
1702 - name: is-closed-loop-disabled
1706 - name: interface-id
1708 description: ID of interface
1713 description: MAC address for the interface
1716 - name: network-name
1718 description: Name of the network
1721 - name: vlan-id-inner
1723 description: Inner VLAN tag
1729 description: This indicates the customers VPN ID associated with this vlan
1732 - name: vlan-id-inner
1734 description: Inner VLAN tag
1738 - name: neutron-network-id
1740 description: Neutron network id of the interface that address belongs to
1743 - name: neutron-subnet-id
1745 description: Neutron id of subnet that address belongs to
1750 - CloudInfrastructure
1751 summary: create or update an existing l3-interface-ipv4-address-list
1753 Create or update an existing l3-interface-ipv4-address-list.
1755 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
1756 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1765 description: Response codes found in [response codes](https://wiki.onap.org/).
1769 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1772 example: __CLOUD-OWNER__
1773 - name: cloud-region-id
1775 description: Identifier used by the vendor for the region. Second part of composite key
1778 example: __CLOUD-REGION-ID__
1781 description: Unique id relative to the cloud-region.
1784 example: __TENANT-ID__
1787 description: Unique identifier for this vserver relative to its tenant
1790 example: __VSERVER-ID__
1791 - name: interface-name
1793 description: Name given to the interface
1796 example: __INTERFACE-NAME__
1797 - name: vlan-interface
1799 description: String that identifies the interface
1802 example: __VLAN-INTERFACE__
1803 - name: l3-interface-ipv4-address
1805 description: IP address
1808 example: __L3-INTERFACE-IPV4-ADDRESS__
1811 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1814 $ref: "#/definitions/l3-interface-ipv4-address-list"
1817 - CloudInfrastructure
1818 summary: update an existing l3-interface-ipv4-address-list
1820 Update an existing l3-interface-ipv4-address-list
1822 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1823 The PUT operation will entirely replace an existing object.
1824 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
1826 Other differences between PUT and PATCH are:
1828 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
1829 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1830 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1831 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1840 description: Response codes found in [response codes](https://wiki.onap.org/).
1844 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1847 example: __CLOUD-OWNER__
1848 - name: cloud-region-id
1850 description: Identifier used by the vendor for the region. Second part of composite key
1853 example: __CLOUD-REGION-ID__
1856 description: Unique id relative to the cloud-region.
1859 example: __TENANT-ID__
1862 description: Unique identifier for this vserver relative to its tenant
1865 example: __VSERVER-ID__
1866 - name: interface-name
1868 description: Name given to the interface
1871 example: __INTERFACE-NAME__
1872 - name: vlan-interface
1874 description: String that identifies the interface
1877 example: __VLAN-INTERFACE__
1878 - name: l3-interface-ipv4-address
1880 description: IP address
1883 example: __L3-INTERFACE-IPV4-ADDRESS__
1886 description: l3-interface-ipv4-address-list object that needs to be created or updated.
1889 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
1892 - CloudInfrastructure
1893 summary: delete an existing l3-interface-ipv4-address-list
1894 description: delete an existing l3-interface-ipv4-address-list
1895 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1904 description: Response codes found in [response codes](https://wiki.onap.org/).
1908 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1911 example: __CLOUD-OWNER__
1912 - name: cloud-region-id
1914 description: Identifier used by the vendor for the region. Second part of composite key
1917 example: __CLOUD-REGION-ID__
1920 description: Unique id relative to the cloud-region.
1923 example: __TENANT-ID__
1926 description: Unique identifier for this vserver relative to its tenant
1929 example: __VSERVER-ID__
1930 - name: interface-name
1932 description: Name given to the interface
1935 example: __INTERFACE-NAME__
1936 - name: vlan-interface
1938 description: String that identifies the interface
1941 example: __VLAN-INTERFACE__
1942 - name: l3-interface-ipv4-address
1944 description: IP address
1947 example: __L3-INTERFACE-IPV4-ADDRESS__
1948 - name: resource-version
1950 description: resource-version for concurrency
1953 /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:
1956 - CloudInfrastructure
1957 summary: see node definition for valid relationships
1958 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1967 description: Response codes found in [response codes](https://wiki.onap.org/).
1971 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1974 example: __CLOUD-OWNER__
1975 - name: cloud-region-id
1977 description: Identifier used by the vendor for the region. Second part of composite key
1980 example: __CLOUD-REGION-ID__
1983 description: Unique id relative to the cloud-region.
1986 example: __TENANT-ID__
1989 description: Unique identifier for this vserver relative to its tenant
1992 example: __VSERVER-ID__
1993 - name: interface-name
1995 description: Name given to the interface
1998 example: __INTERFACE-NAME__
1999 - name: vlan-interface
2001 description: String that identifies the interface
2004 example: __VLAN-INTERFACE__
2005 - name: l3-interface-ipv6-address
2007 description: IP address
2010 example: __L3-INTERFACE-IPV6-ADDRESS__
2013 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2016 $ref: "#/definitions/relationship"
2019 - CloudInfrastructure
2020 summary: delete an existing relationship
2021 description: delete an existing relationship
2022 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
2031 description: Response codes found in [response codes](https://wiki.onap.org/).
2035 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2038 example: __CLOUD-OWNER__
2039 - name: cloud-region-id
2041 description: Identifier used by the vendor for the region. Second part of composite key
2044 example: __CLOUD-REGION-ID__
2047 description: Unique id relative to the cloud-region.
2050 example: __TENANT-ID__
2053 description: Unique identifier for this vserver relative to its tenant
2056 example: __VSERVER-ID__
2057 - name: interface-name
2059 description: Name given to the interface
2062 example: __INTERFACE-NAME__
2063 - name: vlan-interface
2065 description: String that identifies the interface
2068 example: __VLAN-INTERFACE__
2069 - name: l3-interface-ipv6-address
2071 description: IP address
2074 example: __L3-INTERFACE-IPV6-ADDRESS__
2075 /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}:
2078 - CloudInfrastructure
2079 summary: returns l3-interface-ipv6-address-list
2080 description: returns l3-interface-ipv6-address-list
2081 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2087 description: successful operation
2089 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
2091 description: Response codes found in [response codes](https://wiki.onap.org/).
2095 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2098 example: __CLOUD-OWNER__
2099 - name: cloud-region-id
2101 description: Identifier used by the vendor for the region. Second part of composite key
2104 example: __CLOUD-REGION-ID__
2107 description: Unique id relative to the cloud-region.
2110 example: __TENANT-ID__
2113 description: Unique identifier for this vserver relative to its tenant
2116 example: __VSERVER-ID__
2117 - name: interface-name
2119 description: Name given to the interface
2122 example: __INTERFACE-NAME__
2123 - name: vlan-interface
2125 description: String that identifies the interface
2128 example: __VLAN-INTERFACE__
2129 - name: l3-interface-ipv6-address
2131 description: IP address
2134 example: __L3-INTERFACE-IPV6-ADDRESS__
2137 description: Type of the cloud (e.g., openstack)
2140 - name: owner-defined-type
2142 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2147 description: Readable name of tenant
2150 - name: tenant-context
2152 description: This field will store the tenant context.
2155 - name: vserver-name
2157 description: Name of vserver
2160 - name: vserver-name2
2162 description: Alternative name of vserver
2167 description: Trigger for operational monitoring of this resource by Service Assurance systems.
2174 - name: is-closed-loop-disabled
2178 - name: interface-id
2180 description: ID of interface
2185 description: MAC address for the interface
2188 - name: network-name
2190 description: Name of the network
2193 - name: vlan-id-inner
2195 description: Inner VLAN tag
2201 description: This indicates the customers VPN ID associated with this vlan
2204 - name: vlan-id-inner
2206 description: Inner VLAN tag
2210 - name: neutron-network-id
2212 description: Neutron network id of the interface that address belongs to
2215 - name: neutron-subnet-id
2217 description: Neutron id of subnet that address belongs to
2222 - CloudInfrastructure
2223 summary: create or update an existing l3-interface-ipv6-address-list
2225 Create or update an existing l3-interface-ipv6-address-list.
2227 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
2228 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2237 description: Response codes found in [response codes](https://wiki.onap.org/).
2241 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2244 example: __CLOUD-OWNER__
2245 - name: cloud-region-id
2247 description: Identifier used by the vendor for the region. Second part of composite key
2250 example: __CLOUD-REGION-ID__
2253 description: Unique id relative to the cloud-region.
2256 example: __TENANT-ID__
2259 description: Unique identifier for this vserver relative to its tenant
2262 example: __VSERVER-ID__
2263 - name: interface-name
2265 description: Name given to the interface
2268 example: __INTERFACE-NAME__
2269 - name: vlan-interface
2271 description: String that identifies the interface
2274 example: __VLAN-INTERFACE__
2275 - name: l3-interface-ipv6-address
2277 description: IP address
2280 example: __L3-INTERFACE-IPV6-ADDRESS__
2283 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2286 $ref: "#/definitions/l3-interface-ipv6-address-list"
2289 - CloudInfrastructure
2290 summary: update an existing l3-interface-ipv6-address-list
2292 Update an existing l3-interface-ipv6-address-list
2294 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2295 The PUT operation will entirely replace an existing object.
2296 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
2298 Other differences between PUT and PATCH are:
2300 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
2301 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2302 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2303 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2312 description: Response codes found in [response codes](https://wiki.onap.org/).
2316 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2319 example: __CLOUD-OWNER__
2320 - name: cloud-region-id
2322 description: Identifier used by the vendor for the region. Second part of composite key
2325 example: __CLOUD-REGION-ID__
2328 description: Unique id relative to the cloud-region.
2331 example: __TENANT-ID__
2334 description: Unique identifier for this vserver relative to its tenant
2337 example: __VSERVER-ID__
2338 - name: interface-name
2340 description: Name given to the interface
2343 example: __INTERFACE-NAME__
2344 - name: vlan-interface
2346 description: String that identifies the interface
2349 example: __VLAN-INTERFACE__
2350 - name: l3-interface-ipv6-address
2352 description: IP address
2355 example: __L3-INTERFACE-IPV6-ADDRESS__
2358 description: l3-interface-ipv6-address-list object that needs to be created or updated.
2361 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
2364 - CloudInfrastructure
2365 summary: delete an existing l3-interface-ipv6-address-list
2366 description: delete an existing l3-interface-ipv6-address-list
2367 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2376 description: Response codes found in [response codes](https://wiki.onap.org/).
2380 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2383 example: __CLOUD-OWNER__
2384 - name: cloud-region-id
2386 description: Identifier used by the vendor for the region. Second part of composite key
2389 example: __CLOUD-REGION-ID__
2392 description: Unique id relative to the cloud-region.
2395 example: __TENANT-ID__
2398 description: Unique identifier for this vserver relative to its tenant
2401 example: __VSERVER-ID__
2402 - name: interface-name
2404 description: Name given to the interface
2407 example: __INTERFACE-NAME__
2408 - name: vlan-interface
2410 description: String that identifies the interface
2413 example: __VLAN-INTERFACE__
2414 - name: l3-interface-ipv6-address
2416 description: IP address
2419 example: __L3-INTERFACE-IPV6-ADDRESS__
2420 - name: resource-version
2422 description: resource-version for concurrency
2425 /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}:
2428 - CloudInfrastructure
2429 summary: returns vlan
2430 description: returns vlan
2431 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2437 description: successful operation
2439 $ref: "#/getDefinitions/vlan"
2441 description: Response codes found in [response codes](https://wiki.onap.org/).
2445 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2448 example: __CLOUD-OWNER__
2449 - name: cloud-region-id
2451 description: Identifier used by the vendor for the region. Second part of composite key
2454 example: __CLOUD-REGION-ID__
2457 description: Unique id relative to the cloud-region.
2460 example: __TENANT-ID__
2463 description: Unique identifier for this vserver relative to its tenant
2466 example: __VSERVER-ID__
2467 - name: interface-name
2469 description: Name given to the interface
2472 example: __INTERFACE-NAME__
2473 - name: vlan-interface
2475 description: String that identifies the interface
2478 example: __VLAN-INTERFACE__
2481 description: Type of the cloud (e.g., openstack)
2484 - name: owner-defined-type
2486 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2491 description: Readable name of tenant
2494 - name: tenant-context
2496 description: This field will store the tenant context.
2499 - name: vserver-name
2501 description: Name of vserver
2504 - name: vserver-name2
2506 description: Alternative name of vserver
2511 description: Trigger for operational monitoring of this resource by Service Assurance systems.
2518 - name: is-closed-loop-disabled
2522 - name: interface-id
2524 description: ID of interface
2529 description: MAC address for the interface
2532 - name: network-name
2534 description: Name of the network
2537 - name: vlan-id-inner
2539 description: Inner VLAN tag
2545 description: This indicates the customers VPN ID associated with this vlan
2550 - CloudInfrastructure
2551 summary: create or update an existing vlan
2553 Create or update an existing vlan.
2555 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
2556 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2565 description: Response codes found in [response codes](https://wiki.onap.org/).
2569 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2572 example: __CLOUD-OWNER__
2573 - name: cloud-region-id
2575 description: Identifier used by the vendor for the region. Second part of composite key
2578 example: __CLOUD-REGION-ID__
2581 description: Unique id relative to the cloud-region.
2584 example: __TENANT-ID__
2587 description: Unique identifier for this vserver relative to its tenant
2590 example: __VSERVER-ID__
2591 - name: interface-name
2593 description: Name given to the interface
2596 example: __INTERFACE-NAME__
2597 - name: vlan-interface
2599 description: String that identifies the interface
2602 example: __VLAN-INTERFACE__
2605 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2608 $ref: "#/definitions/vlan"
2611 - CloudInfrastructure
2612 summary: update an existing vlan
2614 Update an existing vlan
2616 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2617 The PUT operation will entirely replace an existing object.
2618 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
2620 Other differences between PUT and PATCH are:
2622 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
2623 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2624 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2625 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2634 description: Response codes found in [response codes](https://wiki.onap.org/).
2638 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2641 example: __CLOUD-OWNER__
2642 - name: cloud-region-id
2644 description: Identifier used by the vendor for the region. Second part of composite key
2647 example: __CLOUD-REGION-ID__
2650 description: Unique id relative to the cloud-region.
2653 example: __TENANT-ID__
2656 description: Unique identifier for this vserver relative to its tenant
2659 example: __VSERVER-ID__
2660 - name: interface-name
2662 description: Name given to the interface
2665 example: __INTERFACE-NAME__
2666 - name: vlan-interface
2668 description: String that identifies the interface
2671 example: __VLAN-INTERFACE__
2674 description: vlan object that needs to be created or updated.
2677 $ref: "#/patchDefinitions/vlan"
2680 - CloudInfrastructure
2681 summary: delete an existing vlan
2682 description: delete an existing vlan
2683 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2692 description: Response codes found in [response codes](https://wiki.onap.org/).
2696 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2699 example: __CLOUD-OWNER__
2700 - name: cloud-region-id
2702 description: Identifier used by the vendor for the region. Second part of composite key
2705 example: __CLOUD-REGION-ID__
2708 description: Unique id relative to the cloud-region.
2711 example: __TENANT-ID__
2714 description: Unique identifier for this vserver relative to its tenant
2717 example: __VSERVER-ID__
2718 - name: interface-name
2720 description: Name given to the interface
2723 example: __INTERFACE-NAME__
2724 - name: vlan-interface
2726 description: String that identifies the interface
2729 example: __VLAN-INTERFACE__
2730 - name: resource-version
2732 description: resource-version for concurrency
2735 /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:
2738 - CloudInfrastructure
2739 summary: returns vlans
2740 description: returns vlans
2741 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2747 description: successful operation
2749 $ref: "#/getDefinitions/vlans"
2751 description: Response codes found in [response codes](https://wiki.onap.org/).
2755 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2758 example: __CLOUD-OWNER__
2759 - name: cloud-region-id
2761 description: Identifier used by the vendor for the region. Second part of composite key
2764 example: __CLOUD-REGION-ID__
2767 description: Unique id relative to the cloud-region.
2770 example: __TENANT-ID__
2773 description: Unique identifier for this vserver relative to its tenant
2776 example: __VSERVER-ID__
2777 - name: interface-name
2779 description: Name given to the interface
2782 example: __INTERFACE-NAME__
2785 description: Type of the cloud (e.g., openstack)
2788 - name: owner-defined-type
2790 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2795 description: Readable name of tenant
2798 - name: tenant-context
2800 description: This field will store the tenant context.
2803 - name: vserver-name
2805 description: Name of vserver
2808 - name: vserver-name2
2810 description: Alternative name of vserver
2815 description: Trigger for operational monitoring of this resource by Service Assurance systems.
2822 - name: is-closed-loop-disabled
2826 - name: interface-id
2828 description: ID of interface
2833 description: MAC address for the interface
2836 - name: network-name
2838 description: Name of the network
2841 /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:
2844 - CloudInfrastructure
2845 summary: see node definition for valid relationships
2846 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2855 description: Response codes found in [response codes](https://wiki.onap.org/).
2859 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2862 example: __CLOUD-OWNER__
2863 - name: cloud-region-id
2865 description: Identifier used by the vendor for the region. Second part of composite key
2868 example: __CLOUD-REGION-ID__
2871 description: Unique id relative to the cloud-region.
2874 example: __TENANT-ID__
2877 description: Unique identifier for this vserver relative to its tenant
2880 example: __VSERVER-ID__
2881 - name: interface-name
2883 description: Name given to the interface
2886 example: __INTERFACE-NAME__
2889 description: PCI ID used to identify the sriov-vf
2895 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2898 $ref: "#/definitions/relationship"
2901 - CloudInfrastructure
2902 summary: delete an existing relationship
2903 description: delete an existing relationship
2904 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2913 description: Response codes found in [response codes](https://wiki.onap.org/).
2917 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2920 example: __CLOUD-OWNER__
2921 - name: cloud-region-id
2923 description: Identifier used by the vendor for the region. Second part of composite key
2926 example: __CLOUD-REGION-ID__
2929 description: Unique id relative to the cloud-region.
2932 example: __TENANT-ID__
2935 description: Unique identifier for this vserver relative to its tenant
2938 example: __VSERVER-ID__
2939 - name: interface-name
2941 description: Name given to the interface
2944 example: __INTERFACE-NAME__
2947 description: PCI ID used to identify the sriov-vf
2951 /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}:
2954 - CloudInfrastructure
2955 summary: returns sriov-vf
2956 description: returns sriov-vf
2957 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2963 description: successful operation
2965 $ref: "#/getDefinitions/sriov-vf"
2967 description: Response codes found in [response codes](https://wiki.onap.org/).
2971 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2974 example: __CLOUD-OWNER__
2975 - name: cloud-region-id
2977 description: Identifier used by the vendor for the region. Second part of composite key
2980 example: __CLOUD-REGION-ID__
2983 description: Unique id relative to the cloud-region.
2986 example: __TENANT-ID__
2989 description: Unique identifier for this vserver relative to its tenant
2992 example: __VSERVER-ID__
2993 - name: interface-name
2995 description: Name given to the interface
2998 example: __INTERFACE-NAME__
3001 description: PCI ID used to identify the sriov-vf
3007 description: Type of the cloud (e.g., openstack)
3010 - name: owner-defined-type
3012 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3017 description: Readable name of tenant
3020 - name: tenant-context
3022 description: This field will store the tenant context.
3025 - name: vserver-name
3027 description: Name of vserver
3030 - name: vserver-name2
3032 description: Alternative name of vserver
3037 description: Trigger for operational monitoring of this resource by Service Assurance systems.
3044 - name: is-closed-loop-disabled
3048 - name: interface-id
3050 description: ID of interface
3055 description: MAC address for the interface
3058 - name: network-name
3060 description: Name of the network
3063 - name: vf-vlan-filter
3065 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
3068 - name: vf-mac-filter
3070 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
3073 - name: vf-vlan-strip
3075 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
3078 - name: neutron-network-id
3080 description: Neutron network id of the interface
3085 - CloudInfrastructure
3086 summary: create or update an existing sriov-vf
3088 Create or update an existing sriov-vf.
3090 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
3091 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3100 description: Response codes found in [response codes](https://wiki.onap.org/).
3104 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3107 example: __CLOUD-OWNER__
3108 - name: cloud-region-id
3110 description: Identifier used by the vendor for the region. Second part of composite key
3113 example: __CLOUD-REGION-ID__
3116 description: Unique id relative to the cloud-region.
3119 example: __TENANT-ID__
3122 description: Unique identifier for this vserver relative to its tenant
3125 example: __VSERVER-ID__
3126 - name: interface-name
3128 description: Name given to the interface
3131 example: __INTERFACE-NAME__
3134 description: PCI ID used to identify the sriov-vf
3140 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
3143 $ref: "#/definitions/sriov-vf"
3146 - CloudInfrastructure
3147 summary: update an existing sriov-vf
3149 Update an existing sriov-vf
3151 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3152 The PUT operation will entirely replace an existing object.
3153 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
3155 Other differences between PUT and PATCH are:
3157 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
3158 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3159 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3160 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3169 description: Response codes found in [response codes](https://wiki.onap.org/).
3173 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3176 example: __CLOUD-OWNER__
3177 - name: cloud-region-id
3179 description: Identifier used by the vendor for the region. Second part of composite key
3182 example: __CLOUD-REGION-ID__
3185 description: Unique id relative to the cloud-region.
3188 example: __TENANT-ID__
3191 description: Unique identifier for this vserver relative to its tenant
3194 example: __VSERVER-ID__
3195 - name: interface-name
3197 description: Name given to the interface
3200 example: __INTERFACE-NAME__
3203 description: PCI ID used to identify the sriov-vf
3209 description: sriov-vf object that needs to be created or updated.
3212 $ref: "#/patchDefinitions/sriov-vf"
3215 - CloudInfrastructure
3216 summary: delete an existing sriov-vf
3217 description: delete an existing sriov-vf
3218 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3227 description: Response codes found in [response codes](https://wiki.onap.org/).
3231 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3234 example: __CLOUD-OWNER__
3235 - name: cloud-region-id
3237 description: Identifier used by the vendor for the region. Second part of composite key
3240 example: __CLOUD-REGION-ID__
3243 description: Unique id relative to the cloud-region.
3246 example: __TENANT-ID__
3249 description: Unique identifier for this vserver relative to its tenant
3252 example: __VSERVER-ID__
3253 - name: interface-name
3255 description: Name given to the interface
3258 example: __INTERFACE-NAME__
3261 description: PCI ID used to identify the sriov-vf
3265 - name: resource-version
3267 description: resource-version for concurrency
3270 /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:
3273 - CloudInfrastructure
3274 summary: returns sriov-vfs
3275 description: returns sriov-vfs
3276 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
3282 description: successful operation
3284 $ref: "#/getDefinitions/sriov-vfs"
3286 description: Response codes found in [response codes](https://wiki.onap.org/).
3290 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3293 example: __CLOUD-OWNER__
3294 - name: cloud-region-id
3296 description: Identifier used by the vendor for the region. Second part of composite key
3299 example: __CLOUD-REGION-ID__
3302 description: Unique id relative to the cloud-region.
3305 example: __TENANT-ID__
3308 description: Unique identifier for this vserver relative to its tenant
3311 example: __VSERVER-ID__
3312 - name: interface-name
3314 description: Name given to the interface
3317 example: __INTERFACE-NAME__
3320 description: Type of the cloud (e.g., openstack)
3323 - name: owner-defined-type
3325 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3330 description: Readable name of tenant
3333 - name: tenant-context
3335 description: This field will store the tenant context.
3338 - name: vserver-name
3340 description: Name of vserver
3343 - name: vserver-name2
3345 description: Alternative name of vserver
3350 description: Trigger for operational monitoring of this resource by Service Assurance systems.
3357 - name: is-closed-loop-disabled
3361 - name: interface-id
3363 description: ID of interface
3368 description: MAC address for the interface
3371 - name: network-name
3373 description: Name of the network
3376 /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:
3379 - CloudInfrastructure
3380 summary: see node definition for valid relationships
3381 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
3390 description: Response codes found in [response codes](https://wiki.onap.org/).
3394 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3397 example: __CLOUD-OWNER__
3398 - name: cloud-region-id
3400 description: Identifier used by the vendor for the region. Second part of composite key
3403 example: __CLOUD-REGION-ID__
3406 description: Unique id relative to the cloud-region.
3409 example: __TENANT-ID__
3412 description: Unique identifier for this vserver relative to its tenant
3415 example: __VSERVER-ID__
3416 - name: interface-name
3418 description: Name given to the interface
3421 example: __INTERFACE-NAME__
3424 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
3427 $ref: "#/definitions/relationship"
3430 - CloudInfrastructure
3431 summary: delete an existing relationship
3432 description: delete an existing relationship
3433 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
3442 description: Response codes found in [response codes](https://wiki.onap.org/).
3446 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3449 example: __CLOUD-OWNER__
3450 - name: cloud-region-id
3452 description: Identifier used by the vendor for the region. Second part of composite key
3455 example: __CLOUD-REGION-ID__
3458 description: Unique id relative to the cloud-region.
3461 example: __TENANT-ID__
3464 description: Unique identifier for this vserver relative to its tenant
3467 example: __VSERVER-ID__
3468 - name: interface-name
3470 description: Name given to the interface
3473 example: __INTERFACE-NAME__
3474 /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:
3477 - CloudInfrastructure
3478 summary: see node definition for valid relationships
3479 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3488 description: Response codes found in [response codes](https://wiki.onap.org/).
3492 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3495 example: __CLOUD-OWNER__
3496 - name: cloud-region-id
3498 description: Identifier used by the vendor for the region. Second part of composite key
3501 example: __CLOUD-REGION-ID__
3504 description: Unique id relative to the cloud-region.
3507 example: __TENANT-ID__
3510 description: Unique identifier for this vserver relative to its tenant
3513 example: __VSERVER-ID__
3514 - name: interface-name
3516 description: Name given to the interface
3519 example: __INTERFACE-NAME__
3520 - name: l3-interface-ipv4-address
3522 description: IP address
3525 example: __L3-INTERFACE-IPV4-ADDRESS__
3528 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3531 $ref: "#/definitions/relationship"
3534 - CloudInfrastructure
3535 summary: delete an existing relationship
3536 description: delete an existing relationship
3537 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3546 description: Response codes found in [response codes](https://wiki.onap.org/).
3550 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3553 example: __CLOUD-OWNER__
3554 - name: cloud-region-id
3556 description: Identifier used by the vendor for the region. Second part of composite key
3559 example: __CLOUD-REGION-ID__
3562 description: Unique id relative to the cloud-region.
3565 example: __TENANT-ID__
3568 description: Unique identifier for this vserver relative to its tenant
3571 example: __VSERVER-ID__
3572 - name: interface-name
3574 description: Name given to the interface
3577 example: __INTERFACE-NAME__
3578 - name: l3-interface-ipv4-address
3580 description: IP address
3583 example: __L3-INTERFACE-IPV4-ADDRESS__
3584 /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}:
3587 - CloudInfrastructure
3588 summary: returns l3-interface-ipv4-address-list
3589 description: returns l3-interface-ipv4-address-list
3590 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3596 description: successful operation
3598 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
3600 description: Response codes found in [response codes](https://wiki.onap.org/).
3604 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3607 example: __CLOUD-OWNER__
3608 - name: cloud-region-id
3610 description: Identifier used by the vendor for the region. Second part of composite key
3613 example: __CLOUD-REGION-ID__
3616 description: Unique id relative to the cloud-region.
3619 example: __TENANT-ID__
3622 description: Unique identifier for this vserver relative to its tenant
3625 example: __VSERVER-ID__
3626 - name: interface-name
3628 description: Name given to the interface
3631 example: __INTERFACE-NAME__
3632 - name: l3-interface-ipv4-address
3634 description: IP address
3637 example: __L3-INTERFACE-IPV4-ADDRESS__
3640 description: Type of the cloud (e.g., openstack)
3643 - name: owner-defined-type
3645 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3650 description: Readable name of tenant
3653 - name: tenant-context
3655 description: This field will store the tenant context.
3658 - name: vserver-name
3660 description: Name of vserver
3663 - name: vserver-name2
3665 description: Alternative name of vserver
3670 description: Trigger for operational monitoring of this resource by Service Assurance systems.
3677 - name: is-closed-loop-disabled
3681 - name: interface-id
3683 description: ID of interface
3688 description: MAC address for the interface
3691 - name: network-name
3693 description: Name of the network
3696 - name: vlan-id-inner
3698 description: Inner VLAN tag
3702 - name: neutron-network-id
3704 description: Neutron network id of the interface that address belongs to
3707 - name: neutron-subnet-id
3709 description: Neutron id of subnet that address belongs to
3714 - CloudInfrastructure
3715 summary: create or update an existing l3-interface-ipv4-address-list
3717 Create or update an existing l3-interface-ipv4-address-list.
3719 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
3720 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3729 description: Response codes found in [response codes](https://wiki.onap.org/).
3733 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3736 example: __CLOUD-OWNER__
3737 - name: cloud-region-id
3739 description: Identifier used by the vendor for the region. Second part of composite key
3742 example: __CLOUD-REGION-ID__
3745 description: Unique id relative to the cloud-region.
3748 example: __TENANT-ID__
3751 description: Unique identifier for this vserver relative to its tenant
3754 example: __VSERVER-ID__
3755 - name: interface-name
3757 description: Name given to the interface
3760 example: __INTERFACE-NAME__
3761 - name: l3-interface-ipv4-address
3763 description: IP address
3766 example: __L3-INTERFACE-IPV4-ADDRESS__
3769 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3772 $ref: "#/definitions/l3-interface-ipv4-address-list"
3775 - CloudInfrastructure
3776 summary: update an existing l3-interface-ipv4-address-list
3778 Update an existing l3-interface-ipv4-address-list
3780 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3781 The PUT operation will entirely replace an existing object.
3782 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
3784 Other differences between PUT and PATCH are:
3786 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
3787 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3788 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3789 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3798 description: Response codes found in [response codes](https://wiki.onap.org/).
3802 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3805 example: __CLOUD-OWNER__
3806 - name: cloud-region-id
3808 description: Identifier used by the vendor for the region. Second part of composite key
3811 example: __CLOUD-REGION-ID__
3814 description: Unique id relative to the cloud-region.
3817 example: __TENANT-ID__
3820 description: Unique identifier for this vserver relative to its tenant
3823 example: __VSERVER-ID__
3824 - name: interface-name
3826 description: Name given to the interface
3829 example: __INTERFACE-NAME__
3830 - name: l3-interface-ipv4-address
3832 description: IP address
3835 example: __L3-INTERFACE-IPV4-ADDRESS__
3838 description: l3-interface-ipv4-address-list object that needs to be created or updated.
3841 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
3844 - CloudInfrastructure
3845 summary: delete an existing l3-interface-ipv4-address-list
3846 description: delete an existing l3-interface-ipv4-address-list
3847 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3856 description: Response codes found in [response codes](https://wiki.onap.org/).
3860 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3863 example: __CLOUD-OWNER__
3864 - name: cloud-region-id
3866 description: Identifier used by the vendor for the region. Second part of composite key
3869 example: __CLOUD-REGION-ID__
3872 description: Unique id relative to the cloud-region.
3875 example: __TENANT-ID__
3878 description: Unique identifier for this vserver relative to its tenant
3881 example: __VSERVER-ID__
3882 - name: interface-name
3884 description: Name given to the interface
3887 example: __INTERFACE-NAME__
3888 - name: l3-interface-ipv4-address
3890 description: IP address
3893 example: __L3-INTERFACE-IPV4-ADDRESS__
3894 - name: resource-version
3896 description: resource-version for concurrency
3899 /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:
3902 - CloudInfrastructure
3903 summary: see node definition for valid relationships
3904 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3913 description: Response codes found in [response codes](https://wiki.onap.org/).
3917 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3920 example: __CLOUD-OWNER__
3921 - name: cloud-region-id
3923 description: Identifier used by the vendor for the region. Second part of composite key
3926 example: __CLOUD-REGION-ID__
3929 description: Unique id relative to the cloud-region.
3932 example: __TENANT-ID__
3935 description: Unique identifier for this vserver relative to its tenant
3938 example: __VSERVER-ID__
3939 - name: interface-name
3941 description: Name given to the interface
3944 example: __INTERFACE-NAME__
3945 - name: l3-interface-ipv6-address
3947 description: IP address
3950 example: __L3-INTERFACE-IPV6-ADDRESS__
3953 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3956 $ref: "#/definitions/relationship"
3959 - CloudInfrastructure
3960 summary: delete an existing relationship
3961 description: delete an existing relationship
3962 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3971 description: Response codes found in [response codes](https://wiki.onap.org/).
3975 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3978 example: __CLOUD-OWNER__
3979 - name: cloud-region-id
3981 description: Identifier used by the vendor for the region. Second part of composite key
3984 example: __CLOUD-REGION-ID__
3987 description: Unique id relative to the cloud-region.
3990 example: __TENANT-ID__
3993 description: Unique identifier for this vserver relative to its tenant
3996 example: __VSERVER-ID__
3997 - name: interface-name
3999 description: Name given to the interface
4002 example: __INTERFACE-NAME__
4003 - name: l3-interface-ipv6-address
4005 description: IP address
4008 example: __L3-INTERFACE-IPV6-ADDRESS__
4009 /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}:
4012 - CloudInfrastructure
4013 summary: returns l3-interface-ipv6-address-list
4014 description: returns l3-interface-ipv6-address-list
4015 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4021 description: successful operation
4023 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
4025 description: Response codes found in [response codes](https://wiki.onap.org/).
4029 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4032 example: __CLOUD-OWNER__
4033 - name: cloud-region-id
4035 description: Identifier used by the vendor for the region. Second part of composite key
4038 example: __CLOUD-REGION-ID__
4041 description: Unique id relative to the cloud-region.
4044 example: __TENANT-ID__
4047 description: Unique identifier for this vserver relative to its tenant
4050 example: __VSERVER-ID__
4051 - name: interface-name
4053 description: Name given to the interface
4056 example: __INTERFACE-NAME__
4057 - name: l3-interface-ipv6-address
4059 description: IP address
4062 example: __L3-INTERFACE-IPV6-ADDRESS__
4065 description: Type of the cloud (e.g., openstack)
4068 - name: owner-defined-type
4070 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4075 description: Readable name of tenant
4078 - name: tenant-context
4080 description: This field will store the tenant context.
4083 - name: vserver-name
4085 description: Name of vserver
4088 - name: vserver-name2
4090 description: Alternative name of vserver
4095 description: Trigger for operational monitoring of this resource by Service Assurance systems.
4102 - name: is-closed-loop-disabled
4106 - name: interface-id
4108 description: ID of interface
4113 description: MAC address for the interface
4116 - name: network-name
4118 description: Name of the network
4121 - name: vlan-id-inner
4123 description: Inner VLAN tag
4127 - name: neutron-network-id
4129 description: Neutron network id of the interface that address belongs to
4132 - name: neutron-subnet-id
4134 description: Neutron id of subnet that address belongs to
4139 - CloudInfrastructure
4140 summary: create or update an existing l3-interface-ipv6-address-list
4142 Create or update an existing l3-interface-ipv6-address-list.
4144 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4145 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4154 description: Response codes found in [response codes](https://wiki.onap.org/).
4158 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4161 example: __CLOUD-OWNER__
4162 - name: cloud-region-id
4164 description: Identifier used by the vendor for the region. Second part of composite key
4167 example: __CLOUD-REGION-ID__
4170 description: Unique id relative to the cloud-region.
4173 example: __TENANT-ID__
4176 description: Unique identifier for this vserver relative to its tenant
4179 example: __VSERVER-ID__
4180 - name: interface-name
4182 description: Name given to the interface
4185 example: __INTERFACE-NAME__
4186 - name: l3-interface-ipv6-address
4188 description: IP address
4191 example: __L3-INTERFACE-IPV6-ADDRESS__
4194 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
4197 $ref: "#/definitions/l3-interface-ipv6-address-list"
4200 - CloudInfrastructure
4201 summary: update an existing l3-interface-ipv6-address-list
4203 Update an existing l3-interface-ipv6-address-list
4205 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4206 The PUT operation will entirely replace an existing object.
4207 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4209 Other differences between PUT and PATCH are:
4211 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4212 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4213 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4214 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4223 description: Response codes found in [response codes](https://wiki.onap.org/).
4227 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4230 example: __CLOUD-OWNER__
4231 - name: cloud-region-id
4233 description: Identifier used by the vendor for the region. Second part of composite key
4236 example: __CLOUD-REGION-ID__
4239 description: Unique id relative to the cloud-region.
4242 example: __TENANT-ID__
4245 description: Unique identifier for this vserver relative to its tenant
4248 example: __VSERVER-ID__
4249 - name: interface-name
4251 description: Name given to the interface
4254 example: __INTERFACE-NAME__
4255 - name: l3-interface-ipv6-address
4257 description: IP address
4260 example: __L3-INTERFACE-IPV6-ADDRESS__
4263 description: l3-interface-ipv6-address-list object that needs to be created or updated.
4266 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
4269 - CloudInfrastructure
4270 summary: delete an existing l3-interface-ipv6-address-list
4271 description: delete an existing l3-interface-ipv6-address-list
4272 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4281 description: Response codes found in [response codes](https://wiki.onap.org/).
4285 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4288 example: __CLOUD-OWNER__
4289 - name: cloud-region-id
4291 description: Identifier used by the vendor for the region. Second part of composite key
4294 example: __CLOUD-REGION-ID__
4297 description: Unique id relative to the cloud-region.
4300 example: __TENANT-ID__
4303 description: Unique identifier for this vserver relative to its tenant
4306 example: __VSERVER-ID__
4307 - name: interface-name
4309 description: Name given to the interface
4312 example: __INTERFACE-NAME__
4313 - name: l3-interface-ipv6-address
4315 description: IP address
4318 example: __L3-INTERFACE-IPV6-ADDRESS__
4319 - name: resource-version
4321 description: resource-version for concurrency
4324 /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}:
4327 - CloudInfrastructure
4328 summary: returns l-interface
4329 description: returns l-interface
4330 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4336 description: successful operation
4338 $ref: "#/getDefinitions/l-interface"
4340 description: Response codes found in [response codes](https://wiki.onap.org/).
4344 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4347 example: __CLOUD-OWNER__
4348 - name: cloud-region-id
4350 description: Identifier used by the vendor for the region. Second part of composite key
4353 example: __CLOUD-REGION-ID__
4356 description: Unique id relative to the cloud-region.
4359 example: __TENANT-ID__
4362 description: Unique identifier for this vserver relative to its tenant
4365 example: __VSERVER-ID__
4366 - name: interface-name
4368 description: Name given to the interface
4371 example: __INTERFACE-NAME__
4374 description: Type of the cloud (e.g., openstack)
4377 - name: owner-defined-type
4379 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4384 description: Readable name of tenant
4387 - name: tenant-context
4389 description: This field will store the tenant context.
4392 - name: vserver-name
4394 description: Name of vserver
4397 - name: vserver-name2
4399 description: Alternative name of vserver
4404 description: Trigger for operational monitoring of this resource by Service Assurance systems.
4411 - name: is-closed-loop-disabled
4415 - name: interface-id
4417 description: ID of interface
4422 description: MAC address for the interface
4425 - name: network-name
4427 description: Name of the network
4432 - CloudInfrastructure
4433 summary: create or update an existing l-interface
4435 Create or update an existing l-interface.
4437 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4438 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4447 description: Response codes found in [response codes](https://wiki.onap.org/).
4451 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4454 example: __CLOUD-OWNER__
4455 - name: cloud-region-id
4457 description: Identifier used by the vendor for the region. Second part of composite key
4460 example: __CLOUD-REGION-ID__
4463 description: Unique id relative to the cloud-region.
4466 example: __TENANT-ID__
4469 description: Unique identifier for this vserver relative to its tenant
4472 example: __VSERVER-ID__
4473 - name: interface-name
4475 description: Name given to the interface
4478 example: __INTERFACE-NAME__
4481 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
4484 $ref: "#/definitions/l-interface"
4487 - CloudInfrastructure
4488 summary: update an existing l-interface
4490 Update an existing l-interface
4492 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4493 The PUT operation will entirely replace an existing object.
4494 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4496 Other differences between PUT and PATCH are:
4498 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4499 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4500 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4501 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4510 description: Response codes found in [response codes](https://wiki.onap.org/).
4514 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4517 example: __CLOUD-OWNER__
4518 - name: cloud-region-id
4520 description: Identifier used by the vendor for the region. Second part of composite key
4523 example: __CLOUD-REGION-ID__
4526 description: Unique id relative to the cloud-region.
4529 example: __TENANT-ID__
4532 description: Unique identifier for this vserver relative to its tenant
4535 example: __VSERVER-ID__
4536 - name: interface-name
4538 description: Name given to the interface
4541 example: __INTERFACE-NAME__
4544 description: l-interface object that needs to be created or updated.
4547 $ref: "#/patchDefinitions/l-interface"
4550 - CloudInfrastructure
4551 summary: delete an existing l-interface
4552 description: delete an existing l-interface
4553 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4562 description: Response codes found in [response codes](https://wiki.onap.org/).
4566 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4569 example: __CLOUD-OWNER__
4570 - name: cloud-region-id
4572 description: Identifier used by the vendor for the region. Second part of composite key
4575 example: __CLOUD-REGION-ID__
4578 description: Unique id relative to the cloud-region.
4581 example: __TENANT-ID__
4584 description: Unique identifier for this vserver relative to its tenant
4587 example: __VSERVER-ID__
4588 - name: interface-name
4590 description: Name given to the interface
4593 example: __INTERFACE-NAME__
4594 - name: resource-version
4596 description: resource-version for concurrency
4599 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
4602 - CloudInfrastructure
4603 summary: returns l-interfaces
4604 description: returns l-interfaces
4605 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
4611 description: successful operation
4613 $ref: "#/getDefinitions/l-interfaces"
4615 description: Response codes found in [response codes](https://wiki.onap.org/).
4619 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4622 example: __CLOUD-OWNER__
4623 - name: cloud-region-id
4625 description: Identifier used by the vendor for the region. Second part of composite key
4628 example: __CLOUD-REGION-ID__
4631 description: Unique id relative to the cloud-region.
4634 example: __TENANT-ID__
4637 description: Unique identifier for this vserver relative to its tenant
4640 example: __VSERVER-ID__
4643 description: Type of the cloud (e.g., openstack)
4646 - name: owner-defined-type
4648 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4653 description: Readable name of tenant
4656 - name: tenant-context
4658 description: This field will store the tenant context.
4661 - name: vserver-name
4663 description: Name of vserver
4666 - name: vserver-name2
4668 description: Alternative name of vserver
4673 description: Trigger for operational monitoring of this resource by Service Assurance systems.
4680 - name: is-closed-loop-disabled
4684 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
4687 - CloudInfrastructure
4688 summary: returns vserver
4689 description: returns vserver
4690 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4696 description: successful operation
4698 $ref: "#/getDefinitions/vserver"
4700 description: Response codes found in [response codes](https://wiki.onap.org/).
4704 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4707 example: __CLOUD-OWNER__
4708 - name: cloud-region-id
4710 description: Identifier used by the vendor for the region. Second part of composite key
4713 example: __CLOUD-REGION-ID__
4716 description: Unique id relative to the cloud-region.
4719 example: __TENANT-ID__
4722 description: Unique identifier for this vserver relative to its tenant
4725 example: __VSERVER-ID__
4728 description: Type of the cloud (e.g., openstack)
4731 - name: owner-defined-type
4733 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4738 description: Readable name of tenant
4741 - name: tenant-context
4743 description: This field will store the tenant context.
4746 - name: vserver-name
4748 description: Name of vserver
4751 - name: vserver-name2
4753 description: Alternative name of vserver
4758 description: Trigger for operational monitoring of this resource by Service Assurance systems.
4765 - name: is-closed-loop-disabled
4771 - CloudInfrastructure
4772 summary: create or update an existing vserver
4774 Create or update an existing vserver.
4776 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4777 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4786 description: Response codes found in [response codes](https://wiki.onap.org/).
4790 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4793 example: __CLOUD-OWNER__
4794 - name: cloud-region-id
4796 description: Identifier used by the vendor for the region. Second part of composite key
4799 example: __CLOUD-REGION-ID__
4802 description: Unique id relative to the cloud-region.
4805 example: __TENANT-ID__
4808 description: Unique identifier for this vserver relative to its tenant
4811 example: __VSERVER-ID__
4814 description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
4817 $ref: "#/definitions/vserver"
4820 - CloudInfrastructure
4821 summary: update an existing vserver
4823 Update an existing vserver
4825 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4826 The PUT operation will entirely replace an existing object.
4827 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4829 Other differences between PUT and PATCH are:
4831 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4832 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4833 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4834 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4843 description: Response codes found in [response codes](https://wiki.onap.org/).
4847 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4850 example: __CLOUD-OWNER__
4851 - name: cloud-region-id
4853 description: Identifier used by the vendor for the region. Second part of composite key
4856 example: __CLOUD-REGION-ID__
4859 description: Unique id relative to the cloud-region.
4862 example: __TENANT-ID__
4865 description: Unique identifier for this vserver relative to its tenant
4868 example: __VSERVER-ID__
4871 description: vserver object that needs to be created or updated.
4874 $ref: "#/patchDefinitions/vserver"
4877 - CloudInfrastructure
4878 summary: delete an existing vserver
4879 description: delete an existing vserver
4880 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4889 description: Response codes found in [response codes](https://wiki.onap.org/).
4893 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4896 example: __CLOUD-OWNER__
4897 - name: cloud-region-id
4899 description: Identifier used by the vendor for the region. Second part of composite key
4902 example: __CLOUD-REGION-ID__
4905 description: Unique id relative to the cloud-region.
4908 example: __TENANT-ID__
4911 description: Unique identifier for this vserver relative to its tenant
4914 example: __VSERVER-ID__
4915 - name: resource-version
4917 description: resource-version for concurrency
4920 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
4923 - CloudInfrastructure
4924 summary: returns vservers
4925 description: returns vservers
4926 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
4932 description: successful operation
4934 $ref: "#/getDefinitions/vservers"
4936 description: Response codes found in [response codes](https://wiki.onap.org/).
4940 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4943 example: __CLOUD-OWNER__
4944 - name: cloud-region-id
4946 description: Identifier used by the vendor for the region. Second part of composite key
4949 example: __CLOUD-REGION-ID__
4952 description: Unique id relative to the cloud-region.
4955 example: __TENANT-ID__
4958 description: Type of the cloud (e.g., openstack)
4961 - name: owner-defined-type
4963 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4968 description: Readable name of tenant
4971 - name: tenant-context
4973 description: This field will store the tenant context.
4976 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
4979 - CloudInfrastructure
4980 summary: see node definition for valid relationships
4981 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4990 description: Response codes found in [response codes](https://wiki.onap.org/).
4994 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4997 example: __CLOUD-OWNER__
4998 - name: cloud-region-id
5000 description: Identifier used by the vendor for the region. Second part of composite key
5003 example: __CLOUD-REGION-ID__
5006 description: Unique id relative to the cloud-region.
5009 example: __TENANT-ID__
5012 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
5015 $ref: "#/definitions/relationship"
5018 - CloudInfrastructure
5019 summary: delete an existing relationship
5020 description: delete an existing relationship
5021 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
5030 description: Response codes found in [response codes](https://wiki.onap.org/).
5034 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5037 example: __CLOUD-OWNER__
5038 - name: cloud-region-id
5040 description: Identifier used by the vendor for the region. Second part of composite key
5043 example: __CLOUD-REGION-ID__
5046 description: Unique id relative to the cloud-region.
5049 example: __TENANT-ID__
5050 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
5053 - CloudInfrastructure
5054 summary: returns tenant
5055 description: returns tenant
5056 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5062 description: successful operation
5064 $ref: "#/getDefinitions/tenant"
5066 description: Response codes found in [response codes](https://wiki.onap.org/).
5070 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5073 example: __CLOUD-OWNER__
5074 - name: cloud-region-id
5076 description: Identifier used by the vendor for the region. Second part of composite key
5079 example: __CLOUD-REGION-ID__
5082 description: Unique id relative to the cloud-region.
5085 example: __TENANT-ID__
5088 description: Type of the cloud (e.g., openstack)
5091 - name: owner-defined-type
5093 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5098 description: Readable name of tenant
5101 - name: tenant-context
5103 description: This field will store the tenant context.
5108 - CloudInfrastructure
5109 summary: create or update an existing tenant
5111 Create or update an existing tenant.
5113 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5114 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5123 description: Response codes found in [response codes](https://wiki.onap.org/).
5127 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5130 example: __CLOUD-OWNER__
5131 - name: cloud-region-id
5133 description: Identifier used by the vendor for the region. Second part of composite key
5136 example: __CLOUD-REGION-ID__
5139 description: Unique id relative to the cloud-region.
5142 example: __TENANT-ID__
5145 description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
5148 $ref: "#/definitions/tenant"
5151 - CloudInfrastructure
5152 summary: update an existing tenant
5154 Update an existing tenant
5156 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5157 The PUT operation will entirely replace an existing object.
5158 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5160 Other differences between PUT and PATCH are:
5162 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5163 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5164 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5165 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5174 description: Response codes found in [response codes](https://wiki.onap.org/).
5178 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5181 example: __CLOUD-OWNER__
5182 - name: cloud-region-id
5184 description: Identifier used by the vendor for the region. Second part of composite key
5187 example: __CLOUD-REGION-ID__
5190 description: Unique id relative to the cloud-region.
5193 example: __TENANT-ID__
5196 description: tenant object that needs to be created or updated.
5199 $ref: "#/patchDefinitions/tenant"
5202 - CloudInfrastructure
5203 summary: delete an existing tenant
5204 description: delete an existing tenant
5205 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5214 description: Response codes found in [response codes](https://wiki.onap.org/).
5218 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5221 example: __CLOUD-OWNER__
5222 - name: cloud-region-id
5224 description: Identifier used by the vendor for the region. Second part of composite key
5227 example: __CLOUD-REGION-ID__
5230 description: Unique id relative to the cloud-region.
5233 example: __TENANT-ID__
5234 - name: resource-version
5236 description: resource-version for concurrency
5239 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
5242 - CloudInfrastructure
5243 summary: returns tenants
5244 description: returns tenants
5245 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
5251 description: successful operation
5253 $ref: "#/getDefinitions/tenants"
5255 description: Response codes found in [response codes](https://wiki.onap.org/).
5259 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5262 example: __CLOUD-OWNER__
5263 - name: cloud-region-id
5265 description: Identifier used by the vendor for the region. Second part of composite key
5268 example: __CLOUD-REGION-ID__
5271 description: Type of the cloud (e.g., openstack)
5274 - name: owner-defined-type
5276 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5279 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5282 - CloudInfrastructure
5283 summary: see node definition for valid relationships
5284 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5293 description: Response codes found in [response codes](https://wiki.onap.org/).
5297 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5300 example: __CLOUD-OWNER__
5301 - name: cloud-region-id
5303 description: Identifier used by the vendor for the region. Second part of composite key
5306 example: __CLOUD-REGION-ID__
5309 description: Flavor id, expected to be unique across cloud-region.
5312 example: __FLAVOR-ID__
5315 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5318 $ref: "#/definitions/relationship"
5321 - CloudInfrastructure
5322 summary: delete an existing relationship
5323 description: delete an existing relationship
5324 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5333 description: Response codes found in [response codes](https://wiki.onap.org/).
5337 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5340 example: __CLOUD-OWNER__
5341 - name: cloud-region-id
5343 description: Identifier used by the vendor for the region. Second part of composite key
5346 example: __CLOUD-REGION-ID__
5349 description: Flavor id, expected to be unique across cloud-region.
5352 example: __FLAVOR-ID__
5353 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
5356 - CloudInfrastructure
5357 summary: returns flavor
5358 description: returns flavor
5359 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5365 description: successful operation
5367 $ref: "#/getDefinitions/flavor"
5369 description: Response codes found in [response codes](https://wiki.onap.org/).
5373 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5376 example: __CLOUD-OWNER__
5377 - name: cloud-region-id
5379 description: Identifier used by the vendor for the region. Second part of composite key
5382 example: __CLOUD-REGION-ID__
5385 description: Flavor id, expected to be unique across cloud-region.
5388 example: __FLAVOR-ID__
5391 description: Type of the cloud (e.g., openstack)
5394 - name: owner-defined-type
5396 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5401 description: Flavor name
5406 - CloudInfrastructure
5407 summary: create or update an existing flavor
5409 Create or update an existing flavor.
5411 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5412 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5421 description: Response codes found in [response codes](https://wiki.onap.org/).
5425 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5428 example: __CLOUD-OWNER__
5429 - name: cloud-region-id
5431 description: Identifier used by the vendor for the region. Second part of composite key
5434 example: __CLOUD-REGION-ID__
5437 description: Flavor id, expected to be unique across cloud-region.
5440 example: __FLAVOR-ID__
5443 description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5446 $ref: "#/definitions/flavor"
5449 - CloudInfrastructure
5450 summary: update an existing flavor
5452 Update an existing flavor
5454 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5455 The PUT operation will entirely replace an existing object.
5456 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5458 Other differences between PUT and PATCH are:
5460 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5461 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5462 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5463 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5472 description: Response codes found in [response codes](https://wiki.onap.org/).
5476 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5479 example: __CLOUD-OWNER__
5480 - name: cloud-region-id
5482 description: Identifier used by the vendor for the region. Second part of composite key
5485 example: __CLOUD-REGION-ID__
5488 description: Flavor id, expected to be unique across cloud-region.
5491 example: __FLAVOR-ID__
5494 description: flavor object that needs to be created or updated.
5497 $ref: "#/patchDefinitions/flavor"
5500 - CloudInfrastructure
5501 summary: delete an existing flavor
5502 description: delete an existing flavor
5503 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5512 description: Response codes found in [response codes](https://wiki.onap.org/).
5516 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5519 example: __CLOUD-OWNER__
5520 - name: cloud-region-id
5522 description: Identifier used by the vendor for the region. Second part of composite key
5525 example: __CLOUD-REGION-ID__
5528 description: Flavor id, expected to be unique across cloud-region.
5531 example: __FLAVOR-ID__
5532 - name: resource-version
5534 description: resource-version for concurrency
5537 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
5540 - CloudInfrastructure
5541 summary: returns flavors
5542 description: returns flavors
5543 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
5549 description: successful operation
5551 $ref: "#/getDefinitions/flavors"
5553 description: Response codes found in [response codes](https://wiki.onap.org/).
5557 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5560 example: __CLOUD-OWNER__
5561 - name: cloud-region-id
5563 description: Identifier used by the vendor for the region. Second part of composite key
5566 example: __CLOUD-REGION-ID__
5569 description: Type of the cloud (e.g., openstack)
5572 - name: owner-defined-type
5574 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5577 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
5580 - CloudInfrastructure
5581 summary: see node definition for valid relationships
5582 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5591 description: Response codes found in [response codes](https://wiki.onap.org/).
5595 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5598 example: __CLOUD-OWNER__
5599 - name: cloud-region-id
5601 description: Identifier used by the vendor for the region. Second part of composite key
5604 example: __CLOUD-REGION-ID__
5607 description: Group id, expected to be unique across cloud-region.
5610 example: __GROUP-ID__
5613 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5616 $ref: "#/definitions/relationship"
5619 - CloudInfrastructure
5620 summary: delete an existing relationship
5621 description: delete an existing relationship
5622 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5631 description: Response codes found in [response codes](https://wiki.onap.org/).
5635 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5638 example: __CLOUD-OWNER__
5639 - name: cloud-region-id
5641 description: Identifier used by the vendor for the region. Second part of composite key
5644 example: __CLOUD-REGION-ID__
5647 description: Group id, expected to be unique across cloud-region.
5650 example: __GROUP-ID__
5651 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
5654 - CloudInfrastructure
5655 summary: returns group-assignment
5656 description: returns group-assignment
5657 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5663 description: successful operation
5665 $ref: "#/getDefinitions/group-assignment"
5667 description: Response codes found in [response codes](https://wiki.onap.org/).
5671 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5674 example: __CLOUD-OWNER__
5675 - name: cloud-region-id
5677 description: Identifier used by the vendor for the region. Second part of composite key
5680 example: __CLOUD-REGION-ID__
5683 description: Group id, expected to be unique across cloud-region.
5686 example: __GROUP-ID__
5689 description: Type of the cloud (e.g., openstack)
5692 - name: owner-defined-type
5694 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5699 description: Group type - the type of group this instance refers to
5704 description: Group name - name assigned to the group
5709 - CloudInfrastructure
5710 summary: create or update an existing group-assignment
5712 Create or update an existing group-assignment.
5714 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5715 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5724 description: Response codes found in [response codes](https://wiki.onap.org/).
5728 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5731 example: __CLOUD-OWNER__
5732 - name: cloud-region-id
5734 description: Identifier used by the vendor for the region. Second part of composite key
5737 example: __CLOUD-REGION-ID__
5740 description: Group id, expected to be unique across cloud-region.
5743 example: __GROUP-ID__
5746 description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5749 $ref: "#/definitions/group-assignment"
5752 - CloudInfrastructure
5753 summary: update an existing group-assignment
5755 Update an existing group-assignment
5757 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5758 The PUT operation will entirely replace an existing object.
5759 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5761 Other differences between PUT and PATCH are:
5763 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5764 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5765 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5766 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5775 description: Response codes found in [response codes](https://wiki.onap.org/).
5779 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5782 example: __CLOUD-OWNER__
5783 - name: cloud-region-id
5785 description: Identifier used by the vendor for the region. Second part of composite key
5788 example: __CLOUD-REGION-ID__
5791 description: Group id, expected to be unique across cloud-region.
5794 example: __GROUP-ID__
5797 description: group-assignment object that needs to be created or updated.
5800 $ref: "#/patchDefinitions/group-assignment"
5803 - CloudInfrastructure
5804 summary: delete an existing group-assignment
5805 description: delete an existing group-assignment
5806 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5815 description: Response codes found in [response codes](https://wiki.onap.org/).
5819 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5822 example: __CLOUD-OWNER__
5823 - name: cloud-region-id
5825 description: Identifier used by the vendor for the region. Second part of composite key
5828 example: __CLOUD-REGION-ID__
5831 description: Group id, expected to be unique across cloud-region.
5834 example: __GROUP-ID__
5835 - name: resource-version
5837 description: resource-version for concurrency
5840 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5843 - CloudInfrastructure
5844 summary: returns group-assignments
5845 description: returns group-assignments
5846 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5852 description: successful operation
5854 $ref: "#/getDefinitions/group-assignments"
5856 description: Response codes found in [response codes](https://wiki.onap.org/).
5860 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5863 example: __CLOUD-OWNER__
5864 - name: cloud-region-id
5866 description: Identifier used by the vendor for the region. Second part of composite key
5869 example: __CLOUD-REGION-ID__
5872 description: Type of the cloud (e.g., openstack)
5875 - name: owner-defined-type
5877 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5880 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5883 - CloudInfrastructure
5884 summary: see node definition for valid relationships
5885 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5894 description: Response codes found in [response codes](https://wiki.onap.org/).
5898 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5901 example: __CLOUD-OWNER__
5902 - name: cloud-region-id
5904 description: Identifier used by the vendor for the region. Second part of composite key
5907 example: __CLOUD-REGION-ID__
5910 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5913 example: __SNAPSHOT-ID__
5916 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5919 $ref: "#/definitions/relationship"
5922 - CloudInfrastructure
5923 summary: delete an existing relationship
5924 description: delete an existing relationship
5925 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5934 description: Response codes found in [response codes](https://wiki.onap.org/).
5938 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5941 example: __CLOUD-OWNER__
5942 - name: cloud-region-id
5944 description: Identifier used by the vendor for the region. Second part of composite key
5947 example: __CLOUD-REGION-ID__
5950 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5953 example: __SNAPSHOT-ID__
5954 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5957 - CloudInfrastructure
5958 summary: returns snapshot
5959 description: returns snapshot
5960 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5966 description: successful operation
5968 $ref: "#/getDefinitions/snapshot"
5970 description: Response codes found in [response codes](https://wiki.onap.org/).
5974 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5977 example: __CLOUD-OWNER__
5978 - name: cloud-region-id
5980 description: Identifier used by the vendor for the region. Second part of composite key
5983 example: __CLOUD-REGION-ID__
5986 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5989 example: __SNAPSHOT-ID__
5992 description: Type of the cloud (e.g., openstack)
5995 - name: owner-defined-type
5997 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6000 - name: snapshot-name
6002 description: Snapshot name
6007 description: The application that the image instantiates.
6010 - name: application-vendor
6012 description: The vendor of the application.
6015 - name: application-version
6017 description: The version of the application.
6020 - name: prev-snapshot-id
6022 description: This field contains the UUID of the previous snapshot (if any).
6027 - CloudInfrastructure
6028 summary: create or update an existing snapshot
6030 Create or update an existing snapshot.
6032 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6033 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6042 description: Response codes found in [response codes](https://wiki.onap.org/).
6046 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6049 example: __CLOUD-OWNER__
6050 - name: cloud-region-id
6052 description: Identifier used by the vendor for the region. Second part of composite key
6055 example: __CLOUD-REGION-ID__
6058 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6061 example: __SNAPSHOT-ID__
6064 description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
6067 $ref: "#/definitions/snapshot"
6070 - CloudInfrastructure
6071 summary: update an existing snapshot
6073 Update an existing snapshot
6075 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6076 The PUT operation will entirely replace an existing object.
6077 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6079 Other differences between PUT and PATCH are:
6081 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6082 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6083 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6084 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6093 description: Response codes found in [response codes](https://wiki.onap.org/).
6097 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6100 example: __CLOUD-OWNER__
6101 - name: cloud-region-id
6103 description: Identifier used by the vendor for the region. Second part of composite key
6106 example: __CLOUD-REGION-ID__
6109 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6112 example: __SNAPSHOT-ID__
6115 description: snapshot object that needs to be created or updated.
6118 $ref: "#/patchDefinitions/snapshot"
6121 - CloudInfrastructure
6122 summary: delete an existing snapshot
6123 description: delete an existing snapshot
6124 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6133 description: Response codes found in [response codes](https://wiki.onap.org/).
6137 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6140 example: __CLOUD-OWNER__
6141 - name: cloud-region-id
6143 description: Identifier used by the vendor for the region. Second part of composite key
6146 example: __CLOUD-REGION-ID__
6149 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6152 example: __SNAPSHOT-ID__
6153 - name: resource-version
6155 description: resource-version for concurrency
6158 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
6161 - CloudInfrastructure
6162 summary: returns snapshots
6163 description: returns snapshots
6164 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
6170 description: successful operation
6172 $ref: "#/getDefinitions/snapshots"
6174 description: Response codes found in [response codes](https://wiki.onap.org/).
6178 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6181 example: __CLOUD-OWNER__
6182 - name: cloud-region-id
6184 description: Identifier used by the vendor for the region. Second part of composite key
6187 example: __CLOUD-REGION-ID__
6190 description: Type of the cloud (e.g., openstack)
6193 - name: owner-defined-type
6195 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6198 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6201 - CloudInfrastructure
6202 summary: see node definition for valid relationships
6203 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6212 description: Response codes found in [response codes](https://wiki.onap.org/).
6216 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6219 example: __CLOUD-OWNER__
6220 - name: cloud-region-id
6222 description: Identifier used by the vendor for the region. Second part of composite key
6225 example: __CLOUD-REGION-ID__
6228 description: Image id, expected to be unique across cloud region
6231 example: __IMAGE-ID__
6234 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6237 $ref: "#/definitions/relationship"
6240 - CloudInfrastructure
6241 summary: delete an existing relationship
6242 description: delete an existing relationship
6243 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6252 description: Response codes found in [response codes](https://wiki.onap.org/).
6256 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6259 example: __CLOUD-OWNER__
6260 - name: cloud-region-id
6262 description: Identifier used by the vendor for the region. Second part of composite key
6265 example: __CLOUD-REGION-ID__
6268 description: Image id, expected to be unique across cloud region
6271 example: __IMAGE-ID__
6272 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6275 - CloudInfrastructure
6276 summary: returns metadatum
6277 description: returns metadatum
6278 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6284 description: successful operation
6286 $ref: "#/getDefinitions/metadatum"
6288 description: Response codes found in [response codes](https://wiki.onap.org/).
6292 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6295 example: __CLOUD-OWNER__
6296 - name: cloud-region-id
6298 description: Identifier used by the vendor for the region. Second part of composite key
6301 example: __CLOUD-REGION-ID__
6304 description: Image id, expected to be unique across cloud region
6307 example: __IMAGE-ID__
6312 example: __METANAME__
6315 description: Type of the cloud (e.g., openstack)
6318 - name: owner-defined-type
6320 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6325 description: Image name
6330 description: The application that the image instantiates.
6333 - name: application-vendor
6335 description: The vendor of the application.
6338 - name: application-version
6340 description: The version of the application.
6345 - CloudInfrastructure
6346 summary: create or update an existing metadatum
6348 Create or update an existing metadatum.
6350 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6351 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6360 description: Response codes found in [response codes](https://wiki.onap.org/).
6364 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6367 example: __CLOUD-OWNER__
6368 - name: cloud-region-id
6370 description: Identifier used by the vendor for the region. Second part of composite key
6373 example: __CLOUD-REGION-ID__
6376 description: Image id, expected to be unique across cloud region
6379 example: __IMAGE-ID__
6384 example: __METANAME__
6387 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
6390 $ref: "#/definitions/metadatum"
6393 - CloudInfrastructure
6394 summary: update an existing metadatum
6396 Update an existing metadatum
6398 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6399 The PUT operation will entirely replace an existing object.
6400 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6402 Other differences between PUT and PATCH are:
6404 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6405 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6406 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6407 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6416 description: Response codes found in [response codes](https://wiki.onap.org/).
6420 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6423 example: __CLOUD-OWNER__
6424 - name: cloud-region-id
6426 description: Identifier used by the vendor for the region. Second part of composite key
6429 example: __CLOUD-REGION-ID__
6432 description: Image id, expected to be unique across cloud region
6435 example: __IMAGE-ID__
6440 example: __METANAME__
6443 description: metadatum object that needs to be created or updated.
6446 $ref: "#/patchDefinitions/metadatum"
6449 - CloudInfrastructure
6450 summary: delete an existing metadatum
6451 description: delete an existing metadatum
6452 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6461 description: Response codes found in [response codes](https://wiki.onap.org/).
6465 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6468 example: __CLOUD-OWNER__
6469 - name: cloud-region-id
6471 description: Identifier used by the vendor for the region. Second part of composite key
6474 example: __CLOUD-REGION-ID__
6477 description: Image id, expected to be unique across cloud region
6480 example: __IMAGE-ID__
6485 example: __METANAME__
6486 - name: resource-version
6488 description: resource-version for concurrency
6491 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
6494 - CloudInfrastructure
6495 summary: returns metadata
6496 description: returns metadata
6497 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
6503 description: successful operation
6505 $ref: "#/getDefinitions/metadata"
6507 description: Response codes found in [response codes](https://wiki.onap.org/).
6511 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6514 example: __CLOUD-OWNER__
6515 - name: cloud-region-id
6517 description: Identifier used by the vendor for the region. Second part of composite key
6520 example: __CLOUD-REGION-ID__
6523 description: Image id, expected to be unique across cloud region
6526 example: __IMAGE-ID__
6529 description: Type of the cloud (e.g., openstack)
6532 - name: owner-defined-type
6534 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6539 description: Image name
6544 description: The application that the image instantiates.
6547 - name: application-vendor
6549 description: The vendor of the application.
6552 - name: application-version
6554 description: The version of the application.
6557 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
6560 - CloudInfrastructure
6561 summary: returns image
6562 description: returns image
6563 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
6569 description: successful operation
6571 $ref: "#/getDefinitions/image"
6573 description: Response codes found in [response codes](https://wiki.onap.org/).
6577 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6580 example: __CLOUD-OWNER__
6581 - name: cloud-region-id
6583 description: Identifier used by the vendor for the region. Second part of composite key
6586 example: __CLOUD-REGION-ID__
6589 description: Image id, expected to be unique across cloud region
6592 example: __IMAGE-ID__
6595 description: Type of the cloud (e.g., openstack)
6598 - name: owner-defined-type
6600 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6605 description: Image name
6610 description: The application that the image instantiates.
6613 - name: application-vendor
6615 description: The vendor of the application.
6618 - name: application-version
6620 description: The version of the application.
6625 - CloudInfrastructure
6626 summary: create or update an existing image
6628 Create or update an existing image.
6630 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6631 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6640 description: Response codes found in [response codes](https://wiki.onap.org/).
6644 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6647 example: __CLOUD-OWNER__
6648 - name: cloud-region-id
6650 description: Identifier used by the vendor for the region. Second part of composite key
6653 example: __CLOUD-REGION-ID__
6656 description: Image id, expected to be unique across cloud region
6659 example: __IMAGE-ID__
6662 description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6665 $ref: "#/definitions/image"
6668 - CloudInfrastructure
6669 summary: update an existing image
6671 Update an existing image
6673 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6674 The PUT operation will entirely replace an existing object.
6675 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6677 Other differences between PUT and PATCH are:
6679 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6680 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6681 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6682 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6691 description: Response codes found in [response codes](https://wiki.onap.org/).
6695 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6698 example: __CLOUD-OWNER__
6699 - name: cloud-region-id
6701 description: Identifier used by the vendor for the region. Second part of composite key
6704 example: __CLOUD-REGION-ID__
6707 description: Image id, expected to be unique across cloud region
6710 example: __IMAGE-ID__
6713 description: image object that needs to be created or updated.
6716 $ref: "#/patchDefinitions/image"
6719 - CloudInfrastructure
6720 summary: delete an existing image
6721 description: delete an existing image
6722 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
6731 description: Response codes found in [response codes](https://wiki.onap.org/).
6735 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6738 example: __CLOUD-OWNER__
6739 - name: cloud-region-id
6741 description: Identifier used by the vendor for the region. Second part of composite key
6744 example: __CLOUD-REGION-ID__
6747 description: Image id, expected to be unique across cloud region
6750 example: __IMAGE-ID__
6751 - name: resource-version
6753 description: resource-version for concurrency
6756 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
6759 - CloudInfrastructure
6760 summary: returns images
6761 description: returns images
6762 operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
6768 description: successful operation
6770 $ref: "#/getDefinitions/images"
6772 description: Response codes found in [response codes](https://wiki.onap.org/).
6776 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6779 example: __CLOUD-OWNER__
6780 - name: cloud-region-id
6782 description: Identifier used by the vendor for the region. Second part of composite key
6785 example: __CLOUD-REGION-ID__
6788 description: Type of the cloud (e.g., openstack)
6791 - name: owner-defined-type
6793 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6796 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
6799 - CloudInfrastructure
6800 summary: see node definition for valid relationships
6801 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6810 description: Response codes found in [response codes](https://wiki.onap.org/).
6814 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6817 example: __CLOUD-OWNER__
6818 - name: cloud-region-id
6820 description: Identifier used by the vendor for the region. Second part of composite key
6823 example: __CLOUD-REGION-ID__
6826 description: DVS switch name
6829 example: __SWITCH-NAME__
6832 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6835 $ref: "#/definitions/relationship"
6838 - CloudInfrastructure
6839 summary: delete an existing relationship
6840 description: delete an existing relationship
6841 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6850 description: Response codes found in [response codes](https://wiki.onap.org/).
6854 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6857 example: __CLOUD-OWNER__
6858 - name: cloud-region-id
6860 description: Identifier used by the vendor for the region. Second part of composite key
6863 example: __CLOUD-REGION-ID__
6866 description: DVS switch name
6869 example: __SWITCH-NAME__
6870 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
6873 - CloudInfrastructure
6874 summary: returns dvs-switch
6875 description: returns dvs-switch
6876 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6882 description: successful operation
6884 $ref: "#/getDefinitions/dvs-switch"
6886 description: Response codes found in [response codes](https://wiki.onap.org/).
6890 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6893 example: __CLOUD-OWNER__
6894 - name: cloud-region-id
6896 description: Identifier used by the vendor for the region. Second part of composite key
6899 example: __CLOUD-REGION-ID__
6902 description: DVS switch name
6905 example: __SWITCH-NAME__
6908 description: Type of the cloud (e.g., openstack)
6911 - name: owner-defined-type
6913 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6918 description: URL used to reach the vcenter
6923 - CloudInfrastructure
6924 summary: create or update an existing dvs-switch
6926 Create or update an existing dvs-switch.
6928 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6929 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6938 description: Response codes found in [response codes](https://wiki.onap.org/).
6942 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6945 example: __CLOUD-OWNER__
6946 - name: cloud-region-id
6948 description: Identifier used by the vendor for the region. Second part of composite key
6951 example: __CLOUD-REGION-ID__
6954 description: DVS switch name
6957 example: __SWITCH-NAME__
6960 description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6963 $ref: "#/definitions/dvs-switch"
6966 - CloudInfrastructure
6967 summary: update an existing dvs-switch
6969 Update an existing dvs-switch
6971 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6972 The PUT operation will entirely replace an existing object.
6973 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6975 Other differences between PUT and PATCH are:
6977 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6978 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6979 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6980 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6989 description: Response codes found in [response codes](https://wiki.onap.org/).
6993 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6996 example: __CLOUD-OWNER__
6997 - name: cloud-region-id
6999 description: Identifier used by the vendor for the region. Second part of composite key
7002 example: __CLOUD-REGION-ID__
7005 description: DVS switch name
7008 example: __SWITCH-NAME__
7011 description: dvs-switch object that needs to be created or updated.
7014 $ref: "#/patchDefinitions/dvs-switch"
7017 - CloudInfrastructure
7018 summary: delete an existing dvs-switch
7019 description: delete an existing dvs-switch
7020 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7029 description: Response codes found in [response codes](https://wiki.onap.org/).
7033 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7036 example: __CLOUD-OWNER__
7037 - name: cloud-region-id
7039 description: Identifier used by the vendor for the region. Second part of composite key
7042 example: __CLOUD-REGION-ID__
7045 description: DVS switch name
7048 example: __SWITCH-NAME__
7049 - name: resource-version
7051 description: resource-version for concurrency
7054 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
7057 - CloudInfrastructure
7058 summary: returns dvs-switches
7059 description: returns dvs-switches
7060 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
7066 description: successful operation
7068 $ref: "#/getDefinitions/dvs-switches"
7070 description: Response codes found in [response codes](https://wiki.onap.org/).
7074 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7077 example: __CLOUD-OWNER__
7078 - name: cloud-region-id
7080 description: Identifier used by the vendor for the region. Second part of composite key
7083 example: __CLOUD-REGION-ID__
7086 description: Type of the cloud (e.g., openstack)
7089 - name: owner-defined-type
7091 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7094 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
7097 - CloudInfrastructure
7098 summary: see node definition for valid relationships
7099 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7108 description: Response codes found in [response codes](https://wiki.onap.org/).
7112 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7115 example: __CLOUD-OWNER__
7116 - name: cloud-region-id
7118 description: Identifier used by the vendor for the region. Second part of composite key
7121 example: __CLOUD-REGION-ID__
7122 - name: network-uuid
7124 description: UUID of the network. Unique across a cloud-region
7127 example: __NETWORK-UUID__
7130 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7133 $ref: "#/definitions/relationship"
7136 - CloudInfrastructure
7137 summary: delete an existing relationship
7138 description: delete an existing relationship
7139 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7148 description: Response codes found in [response codes](https://wiki.onap.org/).
7152 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7155 example: __CLOUD-OWNER__
7156 - name: cloud-region-id
7158 description: Identifier used by the vendor for the region. Second part of composite key
7161 example: __CLOUD-REGION-ID__
7162 - name: network-uuid
7164 description: UUID of the network. Unique across a cloud-region
7167 example: __NETWORK-UUID__
7168 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
7171 - CloudInfrastructure
7172 summary: returns oam-network
7173 description: returns oam-network
7174 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7180 description: successful operation
7182 $ref: "#/getDefinitions/oam-network"
7184 description: Response codes found in [response codes](https://wiki.onap.org/).
7188 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7191 example: __CLOUD-OWNER__
7192 - name: cloud-region-id
7194 description: Identifier used by the vendor for the region. Second part of composite key
7197 example: __CLOUD-REGION-ID__
7198 - name: network-uuid
7200 description: UUID of the network. Unique across a cloud-region
7203 example: __NETWORK-UUID__
7206 description: Type of the cloud (e.g., openstack)
7209 - name: owner-defined-type
7211 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7214 - name: network-name
7216 description: Name of the network.
7221 description: cvlan-id
7227 - CloudInfrastructure
7228 summary: create or update an existing oam-network
7230 Create or update an existing oam-network.
7232 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7233 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7242 description: Response codes found in [response codes](https://wiki.onap.org/).
7246 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7249 example: __CLOUD-OWNER__
7250 - name: cloud-region-id
7252 description: Identifier used by the vendor for the region. Second part of composite key
7255 example: __CLOUD-REGION-ID__
7256 - name: network-uuid
7258 description: UUID of the network. Unique across a cloud-region
7261 example: __NETWORK-UUID__
7264 description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7267 $ref: "#/definitions/oam-network"
7270 - CloudInfrastructure
7271 summary: update an existing oam-network
7273 Update an existing oam-network
7275 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7276 The PUT operation will entirely replace an existing object.
7277 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7279 Other differences between PUT and PATCH are:
7281 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7282 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7283 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7284 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7293 description: Response codes found in [response codes](https://wiki.onap.org/).
7297 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7300 example: __CLOUD-OWNER__
7301 - name: cloud-region-id
7303 description: Identifier used by the vendor for the region. Second part of composite key
7306 example: __CLOUD-REGION-ID__
7307 - name: network-uuid
7309 description: UUID of the network. Unique across a cloud-region
7312 example: __NETWORK-UUID__
7315 description: oam-network object that needs to be created or updated.
7318 $ref: "#/patchDefinitions/oam-network"
7321 - CloudInfrastructure
7322 summary: delete an existing oam-network
7323 description: delete an existing oam-network
7324 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7333 description: Response codes found in [response codes](https://wiki.onap.org/).
7337 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7340 example: __CLOUD-OWNER__
7341 - name: cloud-region-id
7343 description: Identifier used by the vendor for the region. Second part of composite key
7346 example: __CLOUD-REGION-ID__
7347 - name: network-uuid
7349 description: UUID of the network. Unique across a cloud-region
7352 example: __NETWORK-UUID__
7353 - name: resource-version
7355 description: resource-version for concurrency
7358 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
7361 - CloudInfrastructure
7362 summary: returns oam-networks
7363 description: returns oam-networks
7364 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
7370 description: successful operation
7372 $ref: "#/getDefinitions/oam-networks"
7374 description: Response codes found in [response codes](https://wiki.onap.org/).
7378 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7381 example: __CLOUD-OWNER__
7382 - name: cloud-region-id
7384 description: Identifier used by the vendor for the region. Second part of composite key
7387 example: __CLOUD-REGION-ID__
7390 description: Type of the cloud (e.g., openstack)
7393 - name: owner-defined-type
7395 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7398 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
7401 - CloudInfrastructure
7402 summary: see node definition for valid relationships
7403 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7412 description: Response codes found in [response codes](https://wiki.onap.org/).
7416 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7419 example: __CLOUD-OWNER__
7420 - name: cloud-region-id
7422 description: Identifier used by the vendor for the region. Second part of composite key
7425 example: __CLOUD-REGION-ID__
7426 - name: availability-zone-name
7428 description: Name of the availability zone. Unique across a cloud region
7431 example: __AVAILABILITY-ZONE-NAME__
7434 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7437 $ref: "#/definitions/relationship"
7440 - CloudInfrastructure
7441 summary: delete an existing relationship
7442 description: delete an existing relationship
7443 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7452 description: Response codes found in [response codes](https://wiki.onap.org/).
7456 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7459 example: __CLOUD-OWNER__
7460 - name: cloud-region-id
7462 description: Identifier used by the vendor for the region. Second part of composite key
7465 example: __CLOUD-REGION-ID__
7466 - name: availability-zone-name
7468 description: Name of the availability zone. Unique across a cloud region
7471 example: __AVAILABILITY-ZONE-NAME__
7472 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
7475 - CloudInfrastructure
7476 summary: returns availability-zone
7477 description: returns availability-zone
7478 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7484 description: successful operation
7486 $ref: "#/getDefinitions/availability-zone"
7488 description: Response codes found in [response codes](https://wiki.onap.org/).
7492 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7495 example: __CLOUD-OWNER__
7496 - name: cloud-region-id
7498 description: Identifier used by the vendor for the region. Second part of composite key
7501 example: __CLOUD-REGION-ID__
7502 - name: availability-zone-name
7504 description: Name of the availability zone. Unique across a cloud region
7507 example: __AVAILABILITY-ZONE-NAME__
7510 description: Type of the cloud (e.g., openstack)
7513 - name: owner-defined-type
7515 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7520 - CloudInfrastructure
7521 summary: create or update an existing availability-zone
7523 Create or update an existing availability-zone.
7525 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7526 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7535 description: Response codes found in [response codes](https://wiki.onap.org/).
7539 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7542 example: __CLOUD-OWNER__
7543 - name: cloud-region-id
7545 description: Identifier used by the vendor for the region. Second part of composite key
7548 example: __CLOUD-REGION-ID__
7549 - name: availability-zone-name
7551 description: Name of the availability zone. Unique across a cloud region
7554 example: __AVAILABILITY-ZONE-NAME__
7557 description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7560 $ref: "#/definitions/availability-zone"
7563 - CloudInfrastructure
7564 summary: update an existing availability-zone
7566 Update an existing availability-zone
7568 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7569 The PUT operation will entirely replace an existing object.
7570 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7572 Other differences between PUT and PATCH are:
7574 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7575 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7576 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7577 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7586 description: Response codes found in [response codes](https://wiki.onap.org/).
7590 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7593 example: __CLOUD-OWNER__
7594 - name: cloud-region-id
7596 description: Identifier used by the vendor for the region. Second part of composite key
7599 example: __CLOUD-REGION-ID__
7600 - name: availability-zone-name
7602 description: Name of the availability zone. Unique across a cloud region
7605 example: __AVAILABILITY-ZONE-NAME__
7608 description: availability-zone object that needs to be created or updated.
7611 $ref: "#/patchDefinitions/availability-zone"
7614 - CloudInfrastructure
7615 summary: delete an existing availability-zone
7616 description: delete an existing availability-zone
7617 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7626 description: Response codes found in [response codes](https://wiki.onap.org/).
7630 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7633 example: __CLOUD-OWNER__
7634 - name: cloud-region-id
7636 description: Identifier used by the vendor for the region. Second part of composite key
7639 example: __CLOUD-REGION-ID__
7640 - name: availability-zone-name
7642 description: Name of the availability zone. Unique across a cloud region
7645 example: __AVAILABILITY-ZONE-NAME__
7646 - name: resource-version
7648 description: resource-version for concurrency
7651 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
7654 - CloudInfrastructure
7655 summary: returns availability-zones
7656 description: returns availability-zones
7657 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
7663 description: successful operation
7665 $ref: "#/getDefinitions/availability-zones"
7667 description: Response codes found in [response codes](https://wiki.onap.org/).
7671 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7674 example: __CLOUD-OWNER__
7675 - name: cloud-region-id
7677 description: Identifier used by the vendor for the region. Second part of composite key
7680 example: __CLOUD-REGION-ID__
7683 description: Type of the cloud (e.g., openstack)
7686 - name: owner-defined-type
7688 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7691 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
7694 - CloudInfrastructure
7695 summary: see node definition for valid relationships
7696 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7705 description: Response codes found in [response codes](https://wiki.onap.org/).
7709 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7712 example: __CLOUD-OWNER__
7713 - name: cloud-region-id
7715 description: Identifier used by the vendor for the region. Second part of composite key
7718 example: __CLOUD-REGION-ID__
7721 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)
7724 $ref: "#/definitions/relationship"
7727 - CloudInfrastructure
7728 summary: delete an existing relationship
7729 description: delete an existing relationship
7730 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7739 description: Response codes found in [response codes](https://wiki.onap.org/).
7743 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7746 example: __CLOUD-OWNER__
7747 - name: cloud-region-id
7749 description: Identifier used by the vendor for the region. Second part of composite key
7752 example: __CLOUD-REGION-ID__
7753 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
7756 - CloudInfrastructure
7757 summary: see node definition for valid relationships
7758 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
7767 description: Response codes found in [response codes](https://wiki.onap.org/).
7771 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7774 example: __CLOUD-OWNER__
7775 - name: cloud-region-id
7777 description: Identifier used by the vendor for the region. Second part of composite key
7780 example: __CLOUD-REGION-ID__
7781 - name: esr-system-info-id
7783 description: Unique ID of esr system info.
7786 example: __ESR-SYSTEM-INFO-ID__
7789 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
7792 $ref: "#/definitions/relationship"
7795 - CloudInfrastructure
7796 summary: delete an existing relationship
7797 description: delete an existing relationship
7798 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
7807 description: Response codes found in [response codes](https://wiki.onap.org/).
7811 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7814 example: __CLOUD-OWNER__
7815 - name: cloud-region-id
7817 description: Identifier used by the vendor for the region. Second part of composite key
7820 example: __CLOUD-REGION-ID__
7821 - name: esr-system-info-id
7823 description: Unique ID of esr system info.
7826 example: __ESR-SYSTEM-INFO-ID__
7827 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
7830 - CloudInfrastructure
7831 summary: returns esr-system-info
7832 description: returns esr-system-info
7833 operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7839 description: successful operation
7841 $ref: "#/getDefinitions/esr-system-info"
7843 description: Response codes found in [response codes](https://wiki.onap.org/).
7847 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7850 example: __CLOUD-OWNER__
7851 - name: cloud-region-id
7853 description: Identifier used by the vendor for the region. Second part of composite key
7856 example: __CLOUD-REGION-ID__
7857 - name: esr-system-info-id
7859 description: Unique ID of esr system info.
7862 example: __ESR-SYSTEM-INFO-ID__
7865 description: Type of the cloud (e.g., openstack)
7868 - name: owner-defined-type
7870 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7875 description: name of external system.
7880 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
7885 - CloudInfrastructure
7886 summary: create or update an existing esr-system-info
7888 Create or update an existing esr-system-info.
7890 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7891 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7900 description: Response codes found in [response codes](https://wiki.onap.org/).
7904 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7907 example: __CLOUD-OWNER__
7908 - name: cloud-region-id
7910 description: Identifier used by the vendor for the region. Second part of composite key
7913 example: __CLOUD-REGION-ID__
7914 - name: esr-system-info-id
7916 description: Unique ID of esr system info.
7919 example: __ESR-SYSTEM-INFO-ID__
7922 description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
7925 $ref: "#/definitions/esr-system-info"
7928 - CloudInfrastructure
7929 summary: update an existing esr-system-info
7931 Update an existing esr-system-info
7933 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7934 The PUT operation will entirely replace an existing object.
7935 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7937 Other differences between PUT and PATCH are:
7939 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7940 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7941 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7942 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7951 description: Response codes found in [response codes](https://wiki.onap.org/).
7955 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7958 example: __CLOUD-OWNER__
7959 - name: cloud-region-id
7961 description: Identifier used by the vendor for the region. Second part of composite key
7964 example: __CLOUD-REGION-ID__
7965 - name: esr-system-info-id
7967 description: Unique ID of esr system info.
7970 example: __ESR-SYSTEM-INFO-ID__
7973 description: esr-system-info object that needs to be created or updated.
7976 $ref: "#/patchDefinitions/esr-system-info"
7979 - CloudInfrastructure
7980 summary: delete an existing esr-system-info
7981 description: delete an existing esr-system-info
7982 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7991 description: Response codes found in [response codes](https://wiki.onap.org/).
7995 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7998 example: __CLOUD-OWNER__
7999 - name: cloud-region-id
8001 description: Identifier used by the vendor for the region. Second part of composite key
8004 example: __CLOUD-REGION-ID__
8005 - name: esr-system-info-id
8007 description: Unique ID of esr system info.
8010 example: __ESR-SYSTEM-INFO-ID__
8011 - name: resource-version
8013 description: resource-version for concurrency
8016 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
8019 - CloudInfrastructure
8020 summary: returns esr-system-info-list
8021 description: returns esr-system-info-list
8022 operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
8028 description: successful operation
8030 $ref: "#/getDefinitions/esr-system-info-list"
8032 description: Response codes found in [response codes](https://wiki.onap.org/).
8036 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8039 example: __CLOUD-OWNER__
8040 - name: cloud-region-id
8042 description: Identifier used by the vendor for the region. Second part of composite key
8045 example: __CLOUD-REGION-ID__
8048 description: Type of the cloud (e.g., openstack)
8051 - name: owner-defined-type
8053 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8056 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
8059 - CloudInfrastructure
8060 summary: see node definition for valid relationships
8061 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
8070 description: Response codes found in [response codes](https://wiki.onap.org/).
8074 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8077 example: __CLOUD-OWNER__
8078 - name: cloud-region-id
8080 description: Identifier used by the vendor for the region. Second part of composite key
8083 example: __CLOUD-REGION-ID__
8084 - name: vip-ipv4-address
8086 description: IP address
8089 example: __VIP-IPV4-ADDRESS__
8092 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
8095 $ref: "#/definitions/relationship"
8098 - CloudInfrastructure
8099 summary: delete an existing relationship
8100 description: delete an existing relationship
8101 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
8110 description: Response codes found in [response codes](https://wiki.onap.org/).
8114 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8117 example: __CLOUD-OWNER__
8118 - name: cloud-region-id
8120 description: Identifier used by the vendor for the region. Second part of composite key
8123 example: __CLOUD-REGION-ID__
8124 - name: vip-ipv4-address
8126 description: IP address
8129 example: __VIP-IPV4-ADDRESS__
8130 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
8133 - CloudInfrastructure
8134 summary: returns vip-ipv4-address-list
8135 description: returns vip-ipv4-address-list
8136 operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8142 description: successful operation
8144 $ref: "#/getDefinitions/vip-ipv4-address-list"
8146 description: Response codes found in [response codes](https://wiki.onap.org/).
8150 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8153 example: __CLOUD-OWNER__
8154 - name: cloud-region-id
8156 description: Identifier used by the vendor for the region. Second part of composite key
8159 example: __CLOUD-REGION-ID__
8160 - name: vip-ipv4-address
8162 description: IP address
8165 example: __VIP-IPV4-ADDRESS__
8168 description: Type of the cloud (e.g., openstack)
8171 - name: owner-defined-type
8173 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8176 - name: vlan-id-inner
8178 description: Inner VLAN tag
8182 - name: neutron-network-id
8184 description: Neutron network id of the interface that address belongs to
8187 - name: neutron-subnet-id
8189 description: Neutron id of subnet that address belongs to
8194 - CloudInfrastructure
8195 summary: create or update an existing vip-ipv4-address-list
8197 Create or update an existing vip-ipv4-address-list.
8199 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8200 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8209 description: Response codes found in [response codes](https://wiki.onap.org/).
8213 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8216 example: __CLOUD-OWNER__
8217 - name: cloud-region-id
8219 description: Identifier used by the vendor for the region. Second part of composite key
8222 example: __CLOUD-REGION-ID__
8223 - name: vip-ipv4-address
8225 description: IP address
8228 example: __VIP-IPV4-ADDRESS__
8231 description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
8234 $ref: "#/definitions/vip-ipv4-address-list"
8237 - CloudInfrastructure
8238 summary: update an existing vip-ipv4-address-list
8240 Update an existing vip-ipv4-address-list
8242 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8243 The PUT operation will entirely replace an existing object.
8244 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8246 Other differences between PUT and PATCH are:
8248 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8249 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8250 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8251 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8260 description: Response codes found in [response codes](https://wiki.onap.org/).
8264 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8267 example: __CLOUD-OWNER__
8268 - name: cloud-region-id
8270 description: Identifier used by the vendor for the region. Second part of composite key
8273 example: __CLOUD-REGION-ID__
8274 - name: vip-ipv4-address
8276 description: IP address
8279 example: __VIP-IPV4-ADDRESS__
8282 description: vip-ipv4-address-list object that needs to be created or updated.
8285 $ref: "#/patchDefinitions/vip-ipv4-address-list"
8288 - CloudInfrastructure
8289 summary: delete an existing vip-ipv4-address-list
8290 description: delete an existing vip-ipv4-address-list
8291 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8300 description: Response codes found in [response codes](https://wiki.onap.org/).
8304 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8307 example: __CLOUD-OWNER__
8308 - name: cloud-region-id
8310 description: Identifier used by the vendor for the region. Second part of composite key
8313 example: __CLOUD-REGION-ID__
8314 - name: vip-ipv4-address
8316 description: IP address
8319 example: __VIP-IPV4-ADDRESS__
8320 - name: resource-version
8322 description: resource-version for concurrency
8325 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
8328 - CloudInfrastructure
8329 summary: see node definition for valid relationships
8330 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8339 description: Response codes found in [response codes](https://wiki.onap.org/).
8343 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8346 example: __CLOUD-OWNER__
8347 - name: cloud-region-id
8349 description: Identifier used by the vendor for the region. Second part of composite key
8352 example: __CLOUD-REGION-ID__
8353 - name: vip-ipv6-address
8355 description: IP address
8358 example: __VIP-IPV6-ADDRESS__
8361 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8364 $ref: "#/definitions/relationship"
8367 - CloudInfrastructure
8368 summary: delete an existing relationship
8369 description: delete an existing relationship
8370 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8379 description: Response codes found in [response codes](https://wiki.onap.org/).
8383 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8386 example: __CLOUD-OWNER__
8387 - name: cloud-region-id
8389 description: Identifier used by the vendor for the region. Second part of composite key
8392 example: __CLOUD-REGION-ID__
8393 - name: vip-ipv6-address
8395 description: IP address
8398 example: __VIP-IPV6-ADDRESS__
8399 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
8402 - CloudInfrastructure
8403 summary: returns vip-ipv6-address-list
8404 description: returns vip-ipv6-address-list
8405 operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8411 description: successful operation
8413 $ref: "#/getDefinitions/vip-ipv6-address-list"
8415 description: Response codes found in [response codes](https://wiki.onap.org/).
8419 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8422 example: __CLOUD-OWNER__
8423 - name: cloud-region-id
8425 description: Identifier used by the vendor for the region. Second part of composite key
8428 example: __CLOUD-REGION-ID__
8429 - name: vip-ipv6-address
8431 description: IP address
8434 example: __VIP-IPV6-ADDRESS__
8437 description: Type of the cloud (e.g., openstack)
8440 - name: owner-defined-type
8442 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8445 - name: vlan-id-inner
8447 description: Inner VLAN tag
8451 - name: neutron-network-id
8453 description: Neutron network id of the interface that address belongs to
8456 - name: neutron-subnet-id
8458 description: Neutron id of subnet that address belongs to
8463 - CloudInfrastructure
8464 summary: create or update an existing vip-ipv6-address-list
8466 Create or update an existing vip-ipv6-address-list.
8468 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8469 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8478 description: Response codes found in [response codes](https://wiki.onap.org/).
8482 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8485 example: __CLOUD-OWNER__
8486 - name: cloud-region-id
8488 description: Identifier used by the vendor for the region. Second part of composite key
8491 example: __CLOUD-REGION-ID__
8492 - name: vip-ipv6-address
8494 description: IP address
8497 example: __VIP-IPV6-ADDRESS__
8500 description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8503 $ref: "#/definitions/vip-ipv6-address-list"
8506 - CloudInfrastructure
8507 summary: update an existing vip-ipv6-address-list
8509 Update an existing vip-ipv6-address-list
8511 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8512 The PUT operation will entirely replace an existing object.
8513 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8515 Other differences between PUT and PATCH are:
8517 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8518 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8519 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8520 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8529 description: Response codes found in [response codes](https://wiki.onap.org/).
8533 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8536 example: __CLOUD-OWNER__
8537 - name: cloud-region-id
8539 description: Identifier used by the vendor for the region. Second part of composite key
8542 example: __CLOUD-REGION-ID__
8543 - name: vip-ipv6-address
8545 description: IP address
8548 example: __VIP-IPV6-ADDRESS__
8551 description: vip-ipv6-address-list object that needs to be created or updated.
8554 $ref: "#/patchDefinitions/vip-ipv6-address-list"
8557 - CloudInfrastructure
8558 summary: delete an existing vip-ipv6-address-list
8559 description: delete an existing vip-ipv6-address-list
8560 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8569 description: Response codes found in [response codes](https://wiki.onap.org/).
8573 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8576 example: __CLOUD-OWNER__
8577 - name: cloud-region-id
8579 description: Identifier used by the vendor for the region. Second part of composite key
8582 example: __CLOUD-REGION-ID__
8583 - name: vip-ipv6-address
8585 description: IP address
8588 example: __VIP-IPV6-ADDRESS__
8589 - name: resource-version
8591 description: resource-version for concurrency
8594 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
8597 - CloudInfrastructure
8598 summary: returns cloud-region
8599 description: returns cloud-region
8600 operationId: getCloudInfrastructureCloudRegionsCloudRegion
8606 description: successful operation
8608 $ref: "#/getDefinitions/cloud-region"
8610 description: Response codes found in [response codes](https://wiki.onap.org/).
8614 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8617 example: __CLOUD-OWNER__
8618 - name: cloud-region-id
8620 description: Identifier used by the vendor for the region. Second part of composite key
8623 example: __CLOUD-REGION-ID__
8626 description: Type of the cloud (e.g., openstack)
8629 - name: owner-defined-type
8631 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8636 - CloudInfrastructure
8637 summary: create or update an existing cloud-region
8639 Create or update an existing cloud-region.
8641 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8642 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
8651 description: Response codes found in [response codes](https://wiki.onap.org/).
8655 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8658 example: __CLOUD-OWNER__
8659 - name: cloud-region-id
8661 description: Identifier used by the vendor for the region. Second part of composite key
8664 example: __CLOUD-REGION-ID__
8667 description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)
8670 $ref: "#/definitions/cloud-region"
8673 - CloudInfrastructure
8674 summary: update an existing cloud-region
8676 Update an existing cloud-region
8678 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8679 The PUT operation will entirely replace an existing object.
8680 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8682 Other differences between PUT and PATCH are:
8684 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8685 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8686 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8687 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
8696 description: Response codes found in [response codes](https://wiki.onap.org/).
8700 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8703 example: __CLOUD-OWNER__
8704 - name: cloud-region-id
8706 description: Identifier used by the vendor for the region. Second part of composite key
8709 example: __CLOUD-REGION-ID__
8712 description: cloud-region object that needs to be created or updated.
8715 $ref: "#/patchDefinitions/cloud-region"
8718 - CloudInfrastructure
8719 summary: delete an existing cloud-region
8720 description: delete an existing cloud-region
8721 operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
8730 description: Response codes found in [response codes](https://wiki.onap.org/).
8734 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8737 example: __CLOUD-OWNER__
8738 - name: cloud-region-id
8740 description: Identifier used by the vendor for the region. Second part of composite key
8743 example: __CLOUD-REGION-ID__
8744 - name: resource-version
8746 description: resource-version for concurrency
8749 /cloud-infrastructure/cloud-regions:
8752 - CloudInfrastructure
8753 summary: returns cloud-regions
8754 description: returns cloud-regions
8755 operationId: getCloudInfrastructureCloudRegions
8761 description: successful operation
8763 $ref: "#/getDefinitions/cloud-regions"
8765 description: Response codes found in [response codes](https://wiki.onap.org/).
8766 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
8769 - CloudInfrastructure
8770 summary: see node definition for valid relationships
8771 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8780 description: Response codes found in [response codes](https://wiki.onap.org/).
8782 - name: nm-profile-name
8784 description: Unique name of network profile.
8787 example: __NM-PROFILE-NAME__
8790 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8793 $ref: "#/definitions/relationship"
8796 - CloudInfrastructure
8797 summary: delete an existing relationship
8798 description: delete an existing relationship
8799 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8808 description: Response codes found in [response codes](https://wiki.onap.org/).
8810 - name: nm-profile-name
8812 description: Unique name of network profile.
8815 example: __NM-PROFILE-NAME__
8816 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
8819 - CloudInfrastructure
8820 summary: returns network-profile
8821 description: returns network-profile
8822 operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
8828 description: successful operation
8830 $ref: "#/getDefinitions/network-profile"
8832 description: Response codes found in [response codes](https://wiki.onap.org/).
8834 - name: nm-profile-name
8836 description: Unique name of network profile.
8839 example: __NM-PROFILE-NAME__
8842 - CloudInfrastructure
8843 summary: create or update an existing network-profile
8845 Create or update an existing network-profile.
8847 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8848 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
8857 description: Response codes found in [response codes](https://wiki.onap.org/).
8859 - name: nm-profile-name
8861 description: Unique name of network profile.
8864 example: __NM-PROFILE-NAME__
8867 description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8870 $ref: "#/definitions/network-profile"
8873 - CloudInfrastructure
8874 summary: update an existing network-profile
8876 Update an existing network-profile
8878 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8879 The PUT operation will entirely replace an existing object.
8880 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8882 Other differences between PUT and PATCH are:
8884 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8885 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8886 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8887 operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
8896 description: Response codes found in [response codes](https://wiki.onap.org/).
8898 - name: nm-profile-name
8900 description: Unique name of network profile.
8903 example: __NM-PROFILE-NAME__
8906 description: network-profile object that needs to be created or updated.
8909 $ref: "#/patchDefinitions/network-profile"
8912 - CloudInfrastructure
8913 summary: delete an existing network-profile
8914 description: delete an existing network-profile
8915 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
8924 description: Response codes found in [response codes](https://wiki.onap.org/).
8926 - name: nm-profile-name
8928 description: Unique name of network profile.
8931 example: __NM-PROFILE-NAME__
8932 - name: resource-version
8934 description: resource-version for concurrency
8937 /cloud-infrastructure/network-profiles:
8940 - CloudInfrastructure
8941 summary: returns network-profiles
8942 description: returns network-profiles
8943 operationId: getCloudInfrastructureNetworkProfiles
8949 description: successful operation
8951 $ref: "#/getDefinitions/network-profiles"
8953 description: Response codes found in [response codes](https://wiki.onap.org/).
8954 /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
8957 - CloudInfrastructure
8958 summary: see node definition for valid relationships
8959 operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
8968 description: Response codes found in [response codes](https://wiki.onap.org/).
8972 description: Value from executing hostname on the compute node.
8975 example: __HOSTNAME__
8978 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)
8981 $ref: "#/definitions/relationship"
8984 - CloudInfrastructure
8985 summary: delete an existing relationship
8986 description: delete an existing relationship
8987 operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
8996 description: Response codes found in [response codes](https://wiki.onap.org/).
9000 description: Value from executing hostname on the compute node.
9003 example: __HOSTNAME__
9004 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
9007 - CloudInfrastructure
9008 summary: see node definition for valid relationships
9009 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9018 description: Response codes found in [response codes](https://wiki.onap.org/).
9022 description: Value from executing hostname on the compute node.
9025 example: __HOSTNAME__
9026 - name: interface-name
9028 description: Name that identifies the physical interface
9031 example: __INTERFACE-NAME__
9034 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9037 $ref: "#/definitions/relationship"
9040 - CloudInfrastructure
9041 summary: delete an existing relationship
9042 description: delete an existing relationship
9043 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9052 description: Response codes found in [response codes](https://wiki.onap.org/).
9056 description: Value from executing hostname on the compute node.
9059 example: __HOSTNAME__
9060 - name: interface-name
9062 description: Name that identifies the physical interface
9065 example: __INTERFACE-NAME__
9066 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
9069 - CloudInfrastructure
9070 summary: see node definition for valid relationships
9071 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9080 description: Response codes found in [response codes](https://wiki.onap.org/).
9084 description: Value from executing hostname on the compute node.
9087 example: __HOSTNAME__
9088 - name: interface-name
9090 description: Name that identifies the physical interface
9093 example: __INTERFACE-NAME__
9096 description: Identifier for the sriov-pf
9099 example: __PF-PCI-ID__
9102 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9105 $ref: "#/definitions/relationship"
9108 - CloudInfrastructure
9109 summary: delete an existing relationship
9110 description: delete an existing relationship
9111 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9120 description: Response codes found in [response codes](https://wiki.onap.org/).
9124 description: Value from executing hostname on the compute node.
9127 example: __HOSTNAME__
9128 - name: interface-name
9130 description: Name that identifies the physical interface
9133 example: __INTERFACE-NAME__
9136 description: Identifier for the sriov-pf
9139 example: __PF-PCI-ID__
9140 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
9143 - CloudInfrastructure
9144 summary: returns sriov-pf
9145 description: returns sriov-pf
9146 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9152 description: successful operation
9154 $ref: "#/getDefinitions/sriov-pf"
9156 description: Response codes found in [response codes](https://wiki.onap.org/).
9160 description: Value from executing hostname on the compute node.
9163 example: __HOSTNAME__
9164 - name: interface-name
9166 description: Name that identifies the physical interface
9169 example: __INTERFACE-NAME__
9172 description: Identifier for the sriov-pf
9175 example: __PF-PCI-ID__
9178 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9183 description: ID of Pserver
9190 - name: pserver-name2
9192 description: alternative pserver name
9197 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9202 - CloudInfrastructure
9203 summary: create or update an existing sriov-pf
9205 Create or update an existing sriov-pf.
9207 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9208 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9217 description: Response codes found in [response codes](https://wiki.onap.org/).
9221 description: Value from executing hostname on the compute node.
9224 example: __HOSTNAME__
9225 - name: interface-name
9227 description: Name that identifies the physical interface
9230 example: __INTERFACE-NAME__
9233 description: Identifier for the sriov-pf
9236 example: __PF-PCI-ID__
9239 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9242 $ref: "#/definitions/sriov-pf"
9245 - CloudInfrastructure
9246 summary: update an existing sriov-pf
9248 Update an existing sriov-pf
9250 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9251 The PUT operation will entirely replace an existing object.
9252 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9254 Other differences between PUT and PATCH are:
9256 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9257 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9258 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9259 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9268 description: Response codes found in [response codes](https://wiki.onap.org/).
9272 description: Value from executing hostname on the compute node.
9275 example: __HOSTNAME__
9276 - name: interface-name
9278 description: Name that identifies the physical interface
9281 example: __INTERFACE-NAME__
9284 description: Identifier for the sriov-pf
9287 example: __PF-PCI-ID__
9290 description: sriov-pf object that needs to be created or updated.
9293 $ref: "#/patchDefinitions/sriov-pf"
9296 - CloudInfrastructure
9297 summary: delete an existing sriov-pf
9298 description: delete an existing sriov-pf
9299 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9308 description: Response codes found in [response codes](https://wiki.onap.org/).
9312 description: Value from executing hostname on the compute node.
9315 example: __HOSTNAME__
9316 - name: interface-name
9318 description: Name that identifies the physical interface
9321 example: __INTERFACE-NAME__
9324 description: Identifier for the sriov-pf
9327 example: __PF-PCI-ID__
9328 - name: resource-version
9330 description: resource-version for concurrency
9333 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
9336 - CloudInfrastructure
9337 summary: returns sriov-pfs
9338 description: returns sriov-pfs
9339 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
9345 description: successful operation
9347 $ref: "#/getDefinitions/sriov-pfs"
9349 description: Response codes found in [response codes](https://wiki.onap.org/).
9353 description: Value from executing hostname on the compute node.
9356 example: __HOSTNAME__
9357 - name: interface-name
9359 description: Name that identifies the physical interface
9362 example: __INTERFACE-NAME__
9365 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9370 description: ID of Pserver
9377 - name: pserver-name2
9379 description: alternative pserver name
9384 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9387 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9390 - CloudInfrastructure
9391 summary: see node definition for valid relationships
9392 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9401 description: Response codes found in [response codes](https://wiki.onap.org/).
9405 description: Value from executing hostname on the compute node.
9408 example: __HOSTNAME__
9409 - name: interface-name
9411 description: Name that identifies the physical interface
9414 example: __INTERFACE-NAME__
9415 - name: interface-name
9417 description: Name given to the interface
9420 example: __INTERFACE-NAME__
9421 - name: vlan-interface
9423 description: String that identifies the interface
9426 example: __VLAN-INTERFACE__
9429 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9432 $ref: "#/definitions/relationship"
9435 - CloudInfrastructure
9436 summary: delete an existing relationship
9437 description: delete an existing relationship
9438 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9447 description: Response codes found in [response codes](https://wiki.onap.org/).
9451 description: Value from executing hostname on the compute node.
9454 example: __HOSTNAME__
9455 - name: interface-name
9457 description: Name that identifies the physical interface
9460 example: __INTERFACE-NAME__
9461 - name: interface-name
9463 description: Name given to the interface
9466 example: __INTERFACE-NAME__
9467 - name: vlan-interface
9469 description: String that identifies the interface
9472 example: __VLAN-INTERFACE__
9473 /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:
9476 - CloudInfrastructure
9477 summary: see node definition for valid relationships
9478 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9487 description: Response codes found in [response codes](https://wiki.onap.org/).
9491 description: Value from executing hostname on the compute node.
9494 example: __HOSTNAME__
9495 - name: interface-name
9497 description: Name that identifies the physical interface
9500 example: __INTERFACE-NAME__
9501 - name: interface-name
9503 description: Name given to the interface
9506 example: __INTERFACE-NAME__
9507 - name: vlan-interface
9509 description: String that identifies the interface
9512 example: __VLAN-INTERFACE__
9513 - name: l3-interface-ipv4-address
9515 description: IP address
9518 example: __L3-INTERFACE-IPV4-ADDRESS__
9521 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9524 $ref: "#/definitions/relationship"
9527 - CloudInfrastructure
9528 summary: delete an existing relationship
9529 description: delete an existing relationship
9530 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9539 description: Response codes found in [response codes](https://wiki.onap.org/).
9543 description: Value from executing hostname on the compute node.
9546 example: __HOSTNAME__
9547 - name: interface-name
9549 description: Name that identifies the physical interface
9552 example: __INTERFACE-NAME__
9553 - name: interface-name
9555 description: Name given to the interface
9558 example: __INTERFACE-NAME__
9559 - name: vlan-interface
9561 description: String that identifies the interface
9564 example: __VLAN-INTERFACE__
9565 - name: l3-interface-ipv4-address
9567 description: IP address
9570 example: __L3-INTERFACE-IPV4-ADDRESS__
9571 /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}:
9574 - CloudInfrastructure
9575 summary: returns l3-interface-ipv4-address-list
9576 description: returns l3-interface-ipv4-address-list
9577 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9583 description: successful operation
9585 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9587 description: Response codes found in [response codes](https://wiki.onap.org/).
9591 description: Value from executing hostname on the compute node.
9594 example: __HOSTNAME__
9595 - name: interface-name
9597 description: Name that identifies the physical interface
9600 example: __INTERFACE-NAME__
9601 - name: interface-name
9603 description: Name given to the interface
9606 example: __INTERFACE-NAME__
9607 - name: vlan-interface
9609 description: String that identifies the interface
9612 example: __VLAN-INTERFACE__
9613 - name: l3-interface-ipv4-address
9615 description: IP address
9618 example: __L3-INTERFACE-IPV4-ADDRESS__
9621 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9626 description: ID of Pserver
9633 - name: pserver-name2
9635 description: alternative pserver name
9640 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9643 - name: interface-id
9645 description: ID of interface
9650 description: MAC address for the interface
9653 - name: network-name
9655 description: Name of the network
9658 - name: vlan-id-inner
9660 description: Inner VLAN tag
9666 description: This indicates the customers VPN ID associated with this vlan
9669 - name: vlan-id-inner
9671 description: Inner VLAN tag
9675 - name: neutron-network-id
9677 description: Neutron network id of the interface that address belongs to
9680 - name: neutron-subnet-id
9682 description: Neutron id of subnet that address belongs to
9687 - CloudInfrastructure
9688 summary: create or update an existing l3-interface-ipv4-address-list
9690 Create or update an existing l3-interface-ipv4-address-list.
9692 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9693 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9702 description: Response codes found in [response codes](https://wiki.onap.org/).
9706 description: Value from executing hostname on the compute node.
9709 example: __HOSTNAME__
9710 - name: interface-name
9712 description: Name that identifies the physical interface
9715 example: __INTERFACE-NAME__
9716 - name: interface-name
9718 description: Name given to the interface
9721 example: __INTERFACE-NAME__
9722 - name: vlan-interface
9724 description: String that identifies the interface
9727 example: __VLAN-INTERFACE__
9728 - name: l3-interface-ipv4-address
9730 description: IP address
9733 example: __L3-INTERFACE-IPV4-ADDRESS__
9736 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9739 $ref: "#/definitions/l3-interface-ipv4-address-list"
9742 - CloudInfrastructure
9743 summary: update an existing l3-interface-ipv4-address-list
9745 Update an existing l3-interface-ipv4-address-list
9747 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9748 The PUT operation will entirely replace an existing object.
9749 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9751 Other differences between PUT and PATCH are:
9753 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9754 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9755 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9756 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9765 description: Response codes found in [response codes](https://wiki.onap.org/).
9769 description: Value from executing hostname on the compute node.
9772 example: __HOSTNAME__
9773 - name: interface-name
9775 description: Name that identifies the physical interface
9778 example: __INTERFACE-NAME__
9779 - name: interface-name
9781 description: Name given to the interface
9784 example: __INTERFACE-NAME__
9785 - name: vlan-interface
9787 description: String that identifies the interface
9790 example: __VLAN-INTERFACE__
9791 - name: l3-interface-ipv4-address
9793 description: IP address
9796 example: __L3-INTERFACE-IPV4-ADDRESS__
9799 description: l3-interface-ipv4-address-list object that needs to be created or updated.
9802 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
9805 - CloudInfrastructure
9806 summary: delete an existing l3-interface-ipv4-address-list
9807 description: delete an existing l3-interface-ipv4-address-list
9808 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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: vlan-interface
9839 description: String that identifies the interface
9842 example: __VLAN-INTERFACE__
9843 - name: l3-interface-ipv4-address
9845 description: IP address
9848 example: __L3-INTERFACE-IPV4-ADDRESS__
9849 - name: resource-version
9851 description: resource-version for concurrency
9854 /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:
9857 - CloudInfrastructure
9858 summary: see node definition for valid relationships
9859 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9868 description: Response codes found in [response codes](https://wiki.onap.org/).
9872 description: Value from executing hostname on the compute node.
9875 example: __HOSTNAME__
9876 - name: interface-name
9878 description: Name that identifies the physical interface
9881 example: __INTERFACE-NAME__
9882 - name: interface-name
9884 description: Name given to the interface
9887 example: __INTERFACE-NAME__
9888 - name: vlan-interface
9890 description: String that identifies the interface
9893 example: __VLAN-INTERFACE__
9894 - name: l3-interface-ipv6-address
9896 description: IP address
9899 example: __L3-INTERFACE-IPV6-ADDRESS__
9902 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
9905 $ref: "#/definitions/relationship"
9908 - CloudInfrastructure
9909 summary: delete an existing relationship
9910 description: delete an existing relationship
9911 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9920 description: Response codes found in [response codes](https://wiki.onap.org/).
9924 description: Value from executing hostname on the compute node.
9927 example: __HOSTNAME__
9928 - name: interface-name
9930 description: Name that identifies the physical interface
9933 example: __INTERFACE-NAME__
9934 - name: interface-name
9936 description: Name given to the interface
9939 example: __INTERFACE-NAME__
9940 - name: vlan-interface
9942 description: String that identifies the interface
9945 example: __VLAN-INTERFACE__
9946 - name: l3-interface-ipv6-address
9948 description: IP address
9951 example: __L3-INTERFACE-IPV6-ADDRESS__
9952 /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}:
9955 - CloudInfrastructure
9956 summary: returns l3-interface-ipv6-address-list
9957 description: returns l3-interface-ipv6-address-list
9958 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9964 description: successful operation
9966 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9968 description: Response codes found in [response codes](https://wiki.onap.org/).
9972 description: Value from executing hostname on the compute node.
9975 example: __HOSTNAME__
9976 - name: interface-name
9978 description: Name that identifies the physical interface
9981 example: __INTERFACE-NAME__
9982 - name: interface-name
9984 description: Name given to the interface
9987 example: __INTERFACE-NAME__
9988 - name: vlan-interface
9990 description: String that identifies the interface
9993 example: __VLAN-INTERFACE__
9994 - name: l3-interface-ipv6-address
9996 description: IP address
9999 example: __L3-INTERFACE-IPV6-ADDRESS__
10002 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10007 description: ID of Pserver
10014 - name: pserver-name2
10016 description: alternative pserver name
10019 - name: prov-status
10021 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10024 - name: interface-id
10026 description: ID of interface
10031 description: MAC address for the interface
10034 - name: network-name
10036 description: Name of the network
10039 - name: vlan-id-inner
10041 description: Inner VLAN tag
10047 description: This indicates the customers VPN ID associated with this vlan
10050 - name: vlan-id-inner
10052 description: Inner VLAN tag
10056 - name: neutron-network-id
10058 description: Neutron network id of the interface that address belongs to
10061 - name: neutron-subnet-id
10063 description: Neutron id of subnet that address belongs to
10068 - CloudInfrastructure
10069 summary: create or update an existing l3-interface-ipv6-address-list
10071 Create or update an existing l3-interface-ipv6-address-list.
10073 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10074 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10083 description: Response codes found in [response codes](https://wiki.onap.org/).
10087 description: Value from executing hostname on the compute node.
10090 example: __HOSTNAME__
10091 - name: interface-name
10093 description: Name that identifies the physical interface
10096 example: __INTERFACE-NAME__
10097 - name: interface-name
10099 description: Name given to the interface
10102 example: __INTERFACE-NAME__
10103 - name: vlan-interface
10105 description: String that identifies the interface
10108 example: __VLAN-INTERFACE__
10109 - name: l3-interface-ipv6-address
10111 description: IP address
10114 example: __L3-INTERFACE-IPV6-ADDRESS__
10117 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10120 $ref: "#/definitions/l3-interface-ipv6-address-list"
10123 - CloudInfrastructure
10124 summary: update an existing l3-interface-ipv6-address-list
10126 Update an existing l3-interface-ipv6-address-list
10128 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10129 The PUT operation will entirely replace an existing object.
10130 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10132 Other differences between PUT and PATCH are:
10134 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10135 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10136 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10137 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10146 description: Response codes found in [response codes](https://wiki.onap.org/).
10150 description: Value from executing hostname on the compute node.
10153 example: __HOSTNAME__
10154 - name: interface-name
10156 description: Name that identifies the physical interface
10159 example: __INTERFACE-NAME__
10160 - name: interface-name
10162 description: Name given to the interface
10165 example: __INTERFACE-NAME__
10166 - name: vlan-interface
10168 description: String that identifies the interface
10171 example: __VLAN-INTERFACE__
10172 - name: l3-interface-ipv6-address
10174 description: IP address
10177 example: __L3-INTERFACE-IPV6-ADDRESS__
10180 description: l3-interface-ipv6-address-list object that needs to be created or updated.
10183 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10186 - CloudInfrastructure
10187 summary: delete an existing l3-interface-ipv6-address-list
10188 description: delete an existing l3-interface-ipv6-address-list
10189 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10198 description: Response codes found in [response codes](https://wiki.onap.org/).
10202 description: Value from executing hostname on the compute node.
10205 example: __HOSTNAME__
10206 - name: interface-name
10208 description: Name that identifies the physical interface
10211 example: __INTERFACE-NAME__
10212 - name: interface-name
10214 description: Name given to the interface
10217 example: __INTERFACE-NAME__
10218 - name: vlan-interface
10220 description: String that identifies the interface
10223 example: __VLAN-INTERFACE__
10224 - name: l3-interface-ipv6-address
10226 description: IP address
10229 example: __L3-INTERFACE-IPV6-ADDRESS__
10230 - name: resource-version
10232 description: resource-version for concurrency
10235 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10238 - CloudInfrastructure
10239 summary: returns vlan
10240 description: returns vlan
10241 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10247 description: successful operation
10249 $ref: "#/getDefinitions/vlan"
10251 description: Response codes found in [response codes](https://wiki.onap.org/).
10255 description: Value from executing hostname on the compute node.
10258 example: __HOSTNAME__
10259 - name: interface-name
10261 description: Name that identifies the physical interface
10264 example: __INTERFACE-NAME__
10265 - name: interface-name
10267 description: Name given to the interface
10270 example: __INTERFACE-NAME__
10271 - name: vlan-interface
10273 description: String that identifies the interface
10276 example: __VLAN-INTERFACE__
10279 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10284 description: ID of Pserver
10291 - name: pserver-name2
10293 description: alternative pserver name
10296 - name: prov-status
10298 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10301 - name: interface-id
10303 description: ID of interface
10308 description: MAC address for the interface
10311 - name: network-name
10313 description: Name of the network
10316 - name: vlan-id-inner
10318 description: Inner VLAN tag
10324 description: This indicates the customers VPN ID associated with this vlan
10329 - CloudInfrastructure
10330 summary: create or update an existing vlan
10332 Create or update an existing vlan.
10334 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10335 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10344 description: Response codes found in [response codes](https://wiki.onap.org/).
10348 description: Value from executing hostname on the compute node.
10351 example: __HOSTNAME__
10352 - name: interface-name
10354 description: Name that identifies the physical interface
10357 example: __INTERFACE-NAME__
10358 - name: interface-name
10360 description: Name given to the interface
10363 example: __INTERFACE-NAME__
10364 - name: vlan-interface
10366 description: String that identifies the interface
10369 example: __VLAN-INTERFACE__
10372 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
10375 $ref: "#/definitions/vlan"
10378 - CloudInfrastructure
10379 summary: update an existing vlan
10381 Update an existing vlan
10383 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10384 The PUT operation will entirely replace an existing object.
10385 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10387 Other differences between PUT and PATCH are:
10389 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10390 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10391 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10392 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10401 description: Response codes found in [response codes](https://wiki.onap.org/).
10405 description: Value from executing hostname on the compute node.
10408 example: __HOSTNAME__
10409 - name: interface-name
10411 description: Name that identifies the physical interface
10414 example: __INTERFACE-NAME__
10415 - name: interface-name
10417 description: Name given to the interface
10420 example: __INTERFACE-NAME__
10421 - name: vlan-interface
10423 description: String that identifies the interface
10426 example: __VLAN-INTERFACE__
10429 description: vlan object that needs to be created or updated.
10432 $ref: "#/patchDefinitions/vlan"
10435 - CloudInfrastructure
10436 summary: delete an existing vlan
10437 description: delete an existing vlan
10438 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10447 description: Response codes found in [response codes](https://wiki.onap.org/).
10451 description: Value from executing hostname on the compute node.
10454 example: __HOSTNAME__
10455 - name: interface-name
10457 description: Name that identifies the physical interface
10460 example: __INTERFACE-NAME__
10461 - name: interface-name
10463 description: Name given to the interface
10466 example: __INTERFACE-NAME__
10467 - name: vlan-interface
10469 description: String that identifies the interface
10472 example: __VLAN-INTERFACE__
10473 - name: resource-version
10475 description: resource-version for concurrency
10478 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10481 - CloudInfrastructure
10482 summary: returns vlans
10483 description: returns vlans
10484 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
10490 description: successful operation
10492 $ref: "#/getDefinitions/vlans"
10494 description: Response codes found in [response codes](https://wiki.onap.org/).
10498 description: Value from executing hostname on the compute node.
10501 example: __HOSTNAME__
10502 - name: interface-name
10504 description: Name that identifies the physical interface
10507 example: __INTERFACE-NAME__
10508 - name: interface-name
10510 description: Name given to the interface
10513 example: __INTERFACE-NAME__
10516 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10521 description: ID of Pserver
10528 - name: pserver-name2
10530 description: alternative pserver name
10533 - name: prov-status
10535 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10538 - name: interface-id
10540 description: ID of interface
10545 description: MAC address for the interface
10548 - name: network-name
10550 description: Name of the network
10553 /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:
10556 - CloudInfrastructure
10557 summary: see node definition for valid relationships
10558 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10567 description: Response codes found in [response codes](https://wiki.onap.org/).
10571 description: Value from executing hostname on the compute node.
10574 example: __HOSTNAME__
10575 - name: interface-name
10577 description: Name that identifies the physical interface
10580 example: __INTERFACE-NAME__
10581 - name: interface-name
10583 description: Name given to the interface
10586 example: __INTERFACE-NAME__
10589 description: PCI ID used to identify the sriov-vf
10592 example: __PCI-ID__
10595 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10598 $ref: "#/definitions/relationship"
10601 - CloudInfrastructure
10602 summary: delete an existing relationship
10603 description: delete an existing relationship
10604 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10613 description: Response codes found in [response codes](https://wiki.onap.org/).
10617 description: Value from executing hostname on the compute node.
10620 example: __HOSTNAME__
10621 - name: interface-name
10623 description: Name that identifies the physical interface
10626 example: __INTERFACE-NAME__
10627 - name: interface-name
10629 description: Name given to the interface
10632 example: __INTERFACE-NAME__
10635 description: PCI ID used to identify the sriov-vf
10638 example: __PCI-ID__
10639 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10642 - CloudInfrastructure
10643 summary: returns sriov-vf
10644 description: returns sriov-vf
10645 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10651 description: successful operation
10653 $ref: "#/getDefinitions/sriov-vf"
10655 description: Response codes found in [response codes](https://wiki.onap.org/).
10659 description: Value from executing hostname on the compute node.
10662 example: __HOSTNAME__
10663 - name: interface-name
10665 description: Name that identifies the physical interface
10668 example: __INTERFACE-NAME__
10669 - name: interface-name
10671 description: Name given to the interface
10674 example: __INTERFACE-NAME__
10677 description: PCI ID used to identify the sriov-vf
10680 example: __PCI-ID__
10683 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10688 description: ID of Pserver
10695 - name: pserver-name2
10697 description: alternative pserver name
10700 - name: prov-status
10702 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10705 - name: interface-id
10707 description: ID of interface
10712 description: MAC address for the interface
10715 - name: network-name
10717 description: Name of the network
10720 - name: vf-vlan-filter
10722 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
10725 - name: vf-mac-filter
10727 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
10730 - name: vf-vlan-strip
10732 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
10735 - name: neutron-network-id
10737 description: Neutron network id of the interface
10742 - CloudInfrastructure
10743 summary: create or update an existing sriov-vf
10745 Create or update an existing sriov-vf.
10747 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10748 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10757 description: Response codes found in [response codes](https://wiki.onap.org/).
10761 description: Value from executing hostname on the compute node.
10764 example: __HOSTNAME__
10765 - name: interface-name
10767 description: Name that identifies the physical interface
10770 example: __INTERFACE-NAME__
10771 - name: interface-name
10773 description: Name given to the interface
10776 example: __INTERFACE-NAME__
10779 description: PCI ID used to identify the sriov-vf
10782 example: __PCI-ID__
10785 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10788 $ref: "#/definitions/sriov-vf"
10791 - CloudInfrastructure
10792 summary: update an existing sriov-vf
10794 Update an existing sriov-vf
10796 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10797 The PUT operation will entirely replace an existing object.
10798 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10800 Other differences between PUT and PATCH are:
10802 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10803 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10804 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10805 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10814 description: Response codes found in [response codes](https://wiki.onap.org/).
10818 description: Value from executing hostname on the compute node.
10821 example: __HOSTNAME__
10822 - name: interface-name
10824 description: Name that identifies the physical interface
10827 example: __INTERFACE-NAME__
10828 - name: interface-name
10830 description: Name given to the interface
10833 example: __INTERFACE-NAME__
10836 description: PCI ID used to identify the sriov-vf
10839 example: __PCI-ID__
10842 description: sriov-vf object that needs to be created or updated.
10845 $ref: "#/patchDefinitions/sriov-vf"
10848 - CloudInfrastructure
10849 summary: delete an existing sriov-vf
10850 description: delete an existing sriov-vf
10851 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10860 description: Response codes found in [response codes](https://wiki.onap.org/).
10864 description: Value from executing hostname on the compute node.
10867 example: __HOSTNAME__
10868 - name: interface-name
10870 description: Name that identifies the physical interface
10873 example: __INTERFACE-NAME__
10874 - name: interface-name
10876 description: Name given to the interface
10879 example: __INTERFACE-NAME__
10882 description: PCI ID used to identify the sriov-vf
10885 example: __PCI-ID__
10886 - name: resource-version
10888 description: resource-version for concurrency
10891 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10894 - CloudInfrastructure
10895 summary: returns sriov-vfs
10896 description: returns sriov-vfs
10897 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
10903 description: successful operation
10905 $ref: "#/getDefinitions/sriov-vfs"
10907 description: Response codes found in [response codes](https://wiki.onap.org/).
10911 description: Value from executing hostname on the compute node.
10914 example: __HOSTNAME__
10915 - name: interface-name
10917 description: Name that identifies the physical interface
10920 example: __INTERFACE-NAME__
10921 - name: interface-name
10923 description: Name given to the interface
10926 example: __INTERFACE-NAME__
10929 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10934 description: ID of Pserver
10941 - name: pserver-name2
10943 description: alternative pserver name
10946 - name: prov-status
10948 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10951 - name: interface-id
10953 description: ID of interface
10958 description: MAC address for the interface
10961 - name: network-name
10963 description: Name of the network
10966 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10969 - CloudInfrastructure
10970 summary: see node definition for valid relationships
10971 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10980 description: Response codes found in [response codes](https://wiki.onap.org/).
10984 description: Value from executing hostname on the compute node.
10987 example: __HOSTNAME__
10988 - name: interface-name
10990 description: Name that identifies the physical interface
10993 example: __INTERFACE-NAME__
10994 - name: interface-name
10996 description: Name given to the interface
10999 example: __INTERFACE-NAME__
11002 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11005 $ref: "#/definitions/relationship"
11008 - CloudInfrastructure
11009 summary: delete an existing relationship
11010 description: delete an existing relationship
11011 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
11020 description: Response codes found in [response codes](https://wiki.onap.org/).
11024 description: Value from executing hostname on the compute node.
11027 example: __HOSTNAME__
11028 - name: interface-name
11030 description: Name that identifies the physical interface
11033 example: __INTERFACE-NAME__
11034 - name: interface-name
11036 description: Name given to the interface
11039 example: __INTERFACE-NAME__
11040 /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:
11043 - CloudInfrastructure
11044 summary: see node definition for valid relationships
11045 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11054 description: Response codes found in [response codes](https://wiki.onap.org/).
11058 description: Value from executing hostname on the compute node.
11061 example: __HOSTNAME__
11062 - name: interface-name
11064 description: Name that identifies the physical interface
11067 example: __INTERFACE-NAME__
11068 - name: interface-name
11070 description: Name given to the interface
11073 example: __INTERFACE-NAME__
11074 - name: l3-interface-ipv4-address
11076 description: IP address
11079 example: __L3-INTERFACE-IPV4-ADDRESS__
11082 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11085 $ref: "#/definitions/relationship"
11088 - CloudInfrastructure
11089 summary: delete an existing relationship
11090 description: delete an existing relationship
11091 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11100 description: Response codes found in [response codes](https://wiki.onap.org/).
11104 description: Value from executing hostname on the compute node.
11107 example: __HOSTNAME__
11108 - name: interface-name
11110 description: Name that identifies the physical interface
11113 example: __INTERFACE-NAME__
11114 - name: interface-name
11116 description: Name given to the interface
11119 example: __INTERFACE-NAME__
11120 - name: l3-interface-ipv4-address
11122 description: IP address
11125 example: __L3-INTERFACE-IPV4-ADDRESS__
11126 /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}:
11129 - CloudInfrastructure
11130 summary: returns l3-interface-ipv4-address-list
11131 description: returns l3-interface-ipv4-address-list
11132 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11138 description: successful operation
11140 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11142 description: Response codes found in [response codes](https://wiki.onap.org/).
11146 description: Value from executing hostname on the compute node.
11149 example: __HOSTNAME__
11150 - name: interface-name
11152 description: Name that identifies the physical interface
11155 example: __INTERFACE-NAME__
11156 - name: interface-name
11158 description: Name given to the interface
11161 example: __INTERFACE-NAME__
11162 - name: l3-interface-ipv4-address
11164 description: IP address
11167 example: __L3-INTERFACE-IPV4-ADDRESS__
11170 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11175 description: ID of Pserver
11182 - name: pserver-name2
11184 description: alternative pserver name
11187 - name: prov-status
11189 description: Trigger for operational monitoring of this resource by Service Assurance systems.
11192 - name: interface-id
11194 description: ID of interface
11199 description: MAC address for the interface
11202 - name: network-name
11204 description: Name of the network
11207 - name: vlan-id-inner
11209 description: Inner VLAN tag
11213 - name: neutron-network-id
11215 description: Neutron network id of the interface that address belongs to
11218 - name: neutron-subnet-id
11220 description: Neutron id of subnet that address belongs to
11225 - CloudInfrastructure
11226 summary: create or update an existing l3-interface-ipv4-address-list
11228 Create or update an existing l3-interface-ipv4-address-list.
11230 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11231 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11240 description: Response codes found in [response codes](https://wiki.onap.org/).
11244 description: Value from executing hostname on the compute node.
11247 example: __HOSTNAME__
11248 - name: interface-name
11250 description: Name that identifies the physical interface
11253 example: __INTERFACE-NAME__
11254 - name: interface-name
11256 description: Name given to the interface
11259 example: __INTERFACE-NAME__
11260 - name: l3-interface-ipv4-address
11262 description: IP address
11265 example: __L3-INTERFACE-IPV4-ADDRESS__
11268 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11271 $ref: "#/definitions/l3-interface-ipv4-address-list"
11274 - CloudInfrastructure
11275 summary: update an existing l3-interface-ipv4-address-list
11277 Update an existing l3-interface-ipv4-address-list
11279 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11280 The PUT operation will entirely replace an existing object.
11281 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11283 Other differences between PUT and PATCH are:
11285 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11286 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11287 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11288 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11297 description: Response codes found in [response codes](https://wiki.onap.org/).
11301 description: Value from executing hostname on the compute node.
11304 example: __HOSTNAME__
11305 - name: interface-name
11307 description: Name that identifies the physical interface
11310 example: __INTERFACE-NAME__
11311 - name: interface-name
11313 description: Name given to the interface
11316 example: __INTERFACE-NAME__
11317 - name: l3-interface-ipv4-address
11319 description: IP address
11322 example: __L3-INTERFACE-IPV4-ADDRESS__
11325 description: l3-interface-ipv4-address-list object that needs to be created or updated.
11328 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11331 - CloudInfrastructure
11332 summary: delete an existing l3-interface-ipv4-address-list
11333 description: delete an existing l3-interface-ipv4-address-list
11334 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11343 description: Response codes found in [response codes](https://wiki.onap.org/).
11347 description: Value from executing hostname on the compute node.
11350 example: __HOSTNAME__
11351 - name: interface-name
11353 description: Name that identifies the physical interface
11356 example: __INTERFACE-NAME__
11357 - name: interface-name
11359 description: Name given to the interface
11362 example: __INTERFACE-NAME__
11363 - name: l3-interface-ipv4-address
11365 description: IP address
11368 example: __L3-INTERFACE-IPV4-ADDRESS__
11369 - name: resource-version
11371 description: resource-version for concurrency
11374 /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:
11377 - CloudInfrastructure
11378 summary: see node definition for valid relationships
11379 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11388 description: Response codes found in [response codes](https://wiki.onap.org/).
11392 description: Value from executing hostname on the compute node.
11395 example: __HOSTNAME__
11396 - name: interface-name
11398 description: Name that identifies the physical interface
11401 example: __INTERFACE-NAME__
11402 - name: interface-name
11404 description: Name given to the interface
11407 example: __INTERFACE-NAME__
11408 - name: l3-interface-ipv6-address
11410 description: IP address
11413 example: __L3-INTERFACE-IPV6-ADDRESS__
11416 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11419 $ref: "#/definitions/relationship"
11422 - CloudInfrastructure
11423 summary: delete an existing relationship
11424 description: delete an existing relationship
11425 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11434 description: Response codes found in [response codes](https://wiki.onap.org/).
11438 description: Value from executing hostname on the compute node.
11441 example: __HOSTNAME__
11442 - name: interface-name
11444 description: Name that identifies the physical interface
11447 example: __INTERFACE-NAME__
11448 - name: interface-name
11450 description: Name given to the interface
11453 example: __INTERFACE-NAME__
11454 - name: l3-interface-ipv6-address
11456 description: IP address
11459 example: __L3-INTERFACE-IPV6-ADDRESS__
11460 /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}:
11463 - CloudInfrastructure
11464 summary: returns l3-interface-ipv6-address-list
11465 description: returns l3-interface-ipv6-address-list
11466 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11472 description: successful operation
11474 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11476 description: Response codes found in [response codes](https://wiki.onap.org/).
11480 description: Value from executing hostname on the compute node.
11483 example: __HOSTNAME__
11484 - name: interface-name
11486 description: Name that identifies the physical interface
11489 example: __INTERFACE-NAME__
11490 - name: interface-name
11492 description: Name given to the interface
11495 example: __INTERFACE-NAME__
11496 - name: l3-interface-ipv6-address
11498 description: IP address
11501 example: __L3-INTERFACE-IPV6-ADDRESS__
11504 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11509 description: ID of Pserver
11516 - name: pserver-name2
11518 description: alternative pserver name
11521 - name: prov-status
11523 description: Trigger for operational monitoring of this resource by Service Assurance systems.
11526 - name: interface-id
11528 description: ID of interface
11533 description: MAC address for the interface
11536 - name: network-name
11538 description: Name of the network
11541 - name: vlan-id-inner
11543 description: Inner VLAN tag
11547 - name: neutron-network-id
11549 description: Neutron network id of the interface that address belongs to
11552 - name: neutron-subnet-id
11554 description: Neutron id of subnet that address belongs to
11559 - CloudInfrastructure
11560 summary: create or update an existing l3-interface-ipv6-address-list
11562 Create or update an existing l3-interface-ipv6-address-list.
11564 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11565 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11574 description: Response codes found in [response codes](https://wiki.onap.org/).
11578 description: Value from executing hostname on the compute node.
11581 example: __HOSTNAME__
11582 - name: interface-name
11584 description: Name that identifies the physical interface
11587 example: __INTERFACE-NAME__
11588 - name: interface-name
11590 description: Name given to the interface
11593 example: __INTERFACE-NAME__
11594 - name: l3-interface-ipv6-address
11596 description: IP address
11599 example: __L3-INTERFACE-IPV6-ADDRESS__
11602 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11605 $ref: "#/definitions/l3-interface-ipv6-address-list"
11608 - CloudInfrastructure
11609 summary: update an existing l3-interface-ipv6-address-list
11611 Update an existing l3-interface-ipv6-address-list
11613 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11614 The PUT operation will entirely replace an existing object.
11615 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11617 Other differences between PUT and PATCH are:
11619 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11620 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11621 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11622 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11631 description: Response codes found in [response codes](https://wiki.onap.org/).
11635 description: Value from executing hostname on the compute node.
11638 example: __HOSTNAME__
11639 - name: interface-name
11641 description: Name that identifies the physical interface
11644 example: __INTERFACE-NAME__
11645 - name: interface-name
11647 description: Name given to the interface
11650 example: __INTERFACE-NAME__
11651 - name: l3-interface-ipv6-address
11653 description: IP address
11656 example: __L3-INTERFACE-IPV6-ADDRESS__
11659 description: l3-interface-ipv6-address-list object that needs to be created or updated.
11662 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11665 - CloudInfrastructure
11666 summary: delete an existing l3-interface-ipv6-address-list
11667 description: delete an existing l3-interface-ipv6-address-list
11668 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11677 description: Response codes found in [response codes](https://wiki.onap.org/).
11681 description: Value from executing hostname on the compute node.
11684 example: __HOSTNAME__
11685 - name: interface-name
11687 description: Name that identifies the physical interface
11690 example: __INTERFACE-NAME__
11691 - name: interface-name
11693 description: Name given to the interface
11696 example: __INTERFACE-NAME__
11697 - name: l3-interface-ipv6-address
11699 description: IP address
11702 example: __L3-INTERFACE-IPV6-ADDRESS__
11703 - name: resource-version
11705 description: resource-version for concurrency
11708 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11711 - CloudInfrastructure
11712 summary: returns l-interface
11713 description: returns l-interface
11714 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11720 description: successful operation
11722 $ref: "#/getDefinitions/l-interface"
11724 description: Response codes found in [response codes](https://wiki.onap.org/).
11728 description: Value from executing hostname on the compute node.
11731 example: __HOSTNAME__
11732 - name: interface-name
11734 description: Name that identifies the physical interface
11737 example: __INTERFACE-NAME__
11738 - name: interface-name
11740 description: Name given to the interface
11743 example: __INTERFACE-NAME__
11746 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11751 description: ID of Pserver
11758 - name: pserver-name2
11760 description: alternative pserver name
11763 - name: prov-status
11765 description: Trigger for operational monitoring of this resource by Service Assurance systems.
11768 - name: interface-id
11770 description: ID of interface
11775 description: MAC address for the interface
11778 - name: network-name
11780 description: Name of the network
11785 - CloudInfrastructure
11786 summary: create or update an existing l-interface
11788 Create or update an existing l-interface.
11790 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11791 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11800 description: Response codes found in [response codes](https://wiki.onap.org/).
11804 description: Value from executing hostname on the compute node.
11807 example: __HOSTNAME__
11808 - name: interface-name
11810 description: Name that identifies the physical interface
11813 example: __INTERFACE-NAME__
11814 - name: interface-name
11816 description: Name given to the interface
11819 example: __INTERFACE-NAME__
11822 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11825 $ref: "#/definitions/l-interface"
11828 - CloudInfrastructure
11829 summary: update an existing l-interface
11831 Update an existing l-interface
11833 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11834 The PUT operation will entirely replace an existing object.
11835 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11837 Other differences between PUT and PATCH are:
11839 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11840 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11841 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11842 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11851 description: Response codes found in [response codes](https://wiki.onap.org/).
11855 description: Value from executing hostname on the compute node.
11858 example: __HOSTNAME__
11859 - name: interface-name
11861 description: Name that identifies the physical interface
11864 example: __INTERFACE-NAME__
11865 - name: interface-name
11867 description: Name given to the interface
11870 example: __INTERFACE-NAME__
11873 description: l-interface object that needs to be created or updated.
11876 $ref: "#/patchDefinitions/l-interface"
11879 - CloudInfrastructure
11880 summary: delete an existing l-interface
11881 description: delete an existing l-interface
11882 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11891 description: Response codes found in [response codes](https://wiki.onap.org/).
11895 description: Value from executing hostname on the compute node.
11898 example: __HOSTNAME__
11899 - name: interface-name
11901 description: Name that identifies the physical interface
11904 example: __INTERFACE-NAME__
11905 - name: interface-name
11907 description: Name given to the interface
11910 example: __INTERFACE-NAME__
11911 - name: resource-version
11913 description: resource-version for concurrency
11916 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
11919 - CloudInfrastructure
11920 summary: returns l-interfaces
11921 description: returns l-interfaces
11922 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
11928 description: successful operation
11930 $ref: "#/getDefinitions/l-interfaces"
11932 description: Response codes found in [response codes](https://wiki.onap.org/).
11936 description: Value from executing hostname on the compute node.
11939 example: __HOSTNAME__
11940 - name: interface-name
11942 description: Name that identifies the physical interface
11945 example: __INTERFACE-NAME__
11948 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11953 description: ID of Pserver
11960 - name: pserver-name2
11962 description: alternative pserver name
11965 - name: prov-status
11967 description: Trigger for operational monitoring of this resource by Service Assurance systems.
11970 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
11973 - CloudInfrastructure
11974 summary: returns p-interface
11975 description: returns p-interface
11976 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
11982 description: successful operation
11984 $ref: "#/getDefinitions/p-interface"
11986 description: Response codes found in [response codes](https://wiki.onap.org/).
11990 description: Value from executing hostname on the compute node.
11993 example: __HOSTNAME__
11994 - name: interface-name
11996 description: Name that identifies the physical interface
11999 example: __INTERFACE-NAME__
12002 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12007 description: ID of Pserver
12014 - name: pserver-name2
12016 description: alternative pserver name
12019 - name: prov-status
12021 description: Trigger for operational monitoring of this resource by Service Assurance systems.
12026 - CloudInfrastructure
12027 summary: create or update an existing p-interface
12029 Create or update an existing p-interface.
12031 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12032 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
12041 description: Response codes found in [response codes](https://wiki.onap.org/).
12045 description: Value from executing hostname on the compute node.
12048 example: __HOSTNAME__
12049 - name: interface-name
12051 description: Name that identifies the physical interface
12054 example: __INTERFACE-NAME__
12057 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
12060 $ref: "#/definitions/p-interface"
12063 - CloudInfrastructure
12064 summary: update an existing p-interface
12066 Update an existing p-interface
12068 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12069 The PUT operation will entirely replace an existing object.
12070 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12072 Other differences between PUT and PATCH are:
12074 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12075 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12076 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12077 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
12086 description: Response codes found in [response codes](https://wiki.onap.org/).
12090 description: Value from executing hostname on the compute node.
12093 example: __HOSTNAME__
12094 - name: interface-name
12096 description: Name that identifies the physical interface
12099 example: __INTERFACE-NAME__
12102 description: p-interface object that needs to be created or updated.
12105 $ref: "#/patchDefinitions/p-interface"
12108 - CloudInfrastructure
12109 summary: delete an existing p-interface
12110 description: delete an existing p-interface
12111 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
12120 description: Response codes found in [response codes](https://wiki.onap.org/).
12124 description: Value from executing hostname on the compute node.
12127 example: __HOSTNAME__
12128 - name: interface-name
12130 description: Name that identifies the physical interface
12133 example: __INTERFACE-NAME__
12134 - name: resource-version
12136 description: resource-version for concurrency
12139 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
12142 - CloudInfrastructure
12143 summary: returns p-interfaces
12144 description: returns p-interfaces
12145 operationId: getCloudInfrastructurePserversPserverPInterfaces
12151 description: successful operation
12153 $ref: "#/getDefinitions/p-interfaces"
12155 description: Response codes found in [response codes](https://wiki.onap.org/).
12159 description: Value from executing hostname on the compute node.
12162 example: __HOSTNAME__
12165 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12170 description: ID of Pserver
12177 - name: pserver-name2
12179 description: alternative pserver name
12182 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
12185 - CloudInfrastructure
12186 summary: see node definition for valid relationships
12187 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
12196 description: Response codes found in [response codes](https://wiki.onap.org/).
12200 description: Value from executing hostname on the compute node.
12203 example: __HOSTNAME__
12204 - name: interface-name
12206 description: Name that identifies the link aggregate interface
12209 example: __INTERFACE-NAME__
12212 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
12215 $ref: "#/definitions/relationship"
12218 - CloudInfrastructure
12219 summary: delete an existing relationship
12220 description: delete an existing relationship
12221 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
12230 description: Response codes found in [response codes](https://wiki.onap.org/).
12234 description: Value from executing hostname on the compute node.
12237 example: __HOSTNAME__
12238 - name: interface-name
12240 description: Name that identifies the link aggregate interface
12243 example: __INTERFACE-NAME__
12244 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
12247 - CloudInfrastructure
12248 summary: see node definition for valid relationships
12249 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
12258 description: Response codes found in [response codes](https://wiki.onap.org/).
12262 description: Value from executing hostname on the compute node.
12265 example: __HOSTNAME__
12266 - name: interface-name
12268 description: Name that identifies the link aggregate interface
12271 example: __INTERFACE-NAME__
12272 - name: interface-name
12274 description: Name given to the interface
12277 example: __INTERFACE-NAME__
12278 - name: vlan-interface
12280 description: String that identifies the interface
12283 example: __VLAN-INTERFACE__
12286 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12289 $ref: "#/definitions/relationship"
12292 - CloudInfrastructure
12293 summary: delete an existing relationship
12294 description: delete an existing relationship
12295 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
12304 description: Response codes found in [response codes](https://wiki.onap.org/).
12308 description: Value from executing hostname on the compute node.
12311 example: __HOSTNAME__
12312 - name: interface-name
12314 description: Name that identifies the link aggregate interface
12317 example: __INTERFACE-NAME__
12318 - name: interface-name
12320 description: Name given to the interface
12323 example: __INTERFACE-NAME__
12324 - name: vlan-interface
12326 description: String that identifies the interface
12329 example: __VLAN-INTERFACE__
12330 /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:
12333 - CloudInfrastructure
12334 summary: see node definition for valid relationships
12335 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
12344 description: Response codes found in [response codes](https://wiki.onap.org/).
12348 description: Value from executing hostname on the compute node.
12351 example: __HOSTNAME__
12352 - name: interface-name
12354 description: Name that identifies the link aggregate interface
12357 example: __INTERFACE-NAME__
12358 - name: interface-name
12360 description: Name given to the interface
12363 example: __INTERFACE-NAME__
12364 - name: vlan-interface
12366 description: String that identifies the interface
12369 example: __VLAN-INTERFACE__
12370 - name: l3-interface-ipv4-address
12372 description: IP address
12375 example: __L3-INTERFACE-IPV4-ADDRESS__
12378 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12381 $ref: "#/definitions/relationship"
12384 - CloudInfrastructure
12385 summary: delete an existing relationship
12386 description: delete an existing relationship
12387 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
12396 description: Response codes found in [response codes](https://wiki.onap.org/).
12400 description: Value from executing hostname on the compute node.
12403 example: __HOSTNAME__
12404 - name: interface-name
12406 description: Name that identifies the link aggregate interface
12409 example: __INTERFACE-NAME__
12410 - name: interface-name
12412 description: Name given to the interface
12415 example: __INTERFACE-NAME__
12416 - name: vlan-interface
12418 description: String that identifies the interface
12421 example: __VLAN-INTERFACE__
12422 - name: l3-interface-ipv4-address
12424 description: IP address
12427 example: __L3-INTERFACE-IPV4-ADDRESS__
12428 /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}:
12431 - CloudInfrastructure
12432 summary: returns l3-interface-ipv4-address-list
12433 description: returns l3-interface-ipv4-address-list
12434 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12440 description: successful operation
12442 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12444 description: Response codes found in [response codes](https://wiki.onap.org/).
12448 description: Value from executing hostname on the compute node.
12451 example: __HOSTNAME__
12452 - name: interface-name
12454 description: Name that identifies the link aggregate interface
12457 example: __INTERFACE-NAME__
12458 - name: interface-name
12460 description: Name given to the interface
12463 example: __INTERFACE-NAME__
12464 - name: vlan-interface
12466 description: String that identifies the interface
12469 example: __VLAN-INTERFACE__
12470 - name: l3-interface-ipv4-address
12472 description: IP address
12475 example: __L3-INTERFACE-IPV4-ADDRESS__
12478 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12483 description: ID of Pserver
12490 - name: pserver-name2
12492 description: alternative pserver name
12495 - name: interface-id
12497 description: ID of interface
12500 - name: interface-role
12502 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12505 - name: interface-id
12507 description: ID of interface
12512 description: MAC address for the interface
12515 - name: network-name
12517 description: Name of the network
12520 - name: vlan-id-inner
12522 description: Inner VLAN tag
12528 description: This indicates the customers VPN ID associated with this vlan
12531 - name: vlan-id-inner
12533 description: Inner VLAN tag
12537 - name: neutron-network-id
12539 description: Neutron network id of the interface that address belongs to
12542 - name: neutron-subnet-id
12544 description: Neutron id of subnet that address belongs to
12549 - CloudInfrastructure
12550 summary: create or update an existing l3-interface-ipv4-address-list
12552 Create or update an existing l3-interface-ipv4-address-list.
12554 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12555 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12564 description: Response codes found in [response codes](https://wiki.onap.org/).
12568 description: Value from executing hostname on the compute node.
12571 example: __HOSTNAME__
12572 - name: interface-name
12574 description: Name that identifies the link aggregate interface
12577 example: __INTERFACE-NAME__
12578 - name: interface-name
12580 description: Name given to the interface
12583 example: __INTERFACE-NAME__
12584 - name: vlan-interface
12586 description: String that identifies the interface
12589 example: __VLAN-INTERFACE__
12590 - name: l3-interface-ipv4-address
12592 description: IP address
12595 example: __L3-INTERFACE-IPV4-ADDRESS__
12598 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12601 $ref: "#/definitions/l3-interface-ipv4-address-list"
12604 - CloudInfrastructure
12605 summary: update an existing l3-interface-ipv4-address-list
12607 Update an existing l3-interface-ipv4-address-list
12609 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12610 The PUT operation will entirely replace an existing object.
12611 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12613 Other differences between PUT and PATCH are:
12615 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12616 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12617 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12618 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12627 description: Response codes found in [response codes](https://wiki.onap.org/).
12631 description: Value from executing hostname on the compute node.
12634 example: __HOSTNAME__
12635 - name: interface-name
12637 description: Name that identifies the link aggregate interface
12640 example: __INTERFACE-NAME__
12641 - name: interface-name
12643 description: Name given to the interface
12646 example: __INTERFACE-NAME__
12647 - name: vlan-interface
12649 description: String that identifies the interface
12652 example: __VLAN-INTERFACE__
12653 - name: l3-interface-ipv4-address
12655 description: IP address
12658 example: __L3-INTERFACE-IPV4-ADDRESS__
12661 description: l3-interface-ipv4-address-list object that needs to be created or updated.
12664 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12667 - CloudInfrastructure
12668 summary: delete an existing l3-interface-ipv4-address-list
12669 description: delete an existing l3-interface-ipv4-address-list
12670 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12679 description: Response codes found in [response codes](https://wiki.onap.org/).
12683 description: Value from executing hostname on the compute node.
12686 example: __HOSTNAME__
12687 - name: interface-name
12689 description: Name that identifies the link aggregate interface
12692 example: __INTERFACE-NAME__
12693 - name: interface-name
12695 description: Name given to the interface
12698 example: __INTERFACE-NAME__
12699 - name: vlan-interface
12701 description: String that identifies the interface
12704 example: __VLAN-INTERFACE__
12705 - name: l3-interface-ipv4-address
12707 description: IP address
12710 example: __L3-INTERFACE-IPV4-ADDRESS__
12711 - name: resource-version
12713 description: resource-version for concurrency
12716 /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:
12719 - CloudInfrastructure
12720 summary: see node definition for valid relationships
12721 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12730 description: Response codes found in [response codes](https://wiki.onap.org/).
12734 description: Value from executing hostname on the compute node.
12737 example: __HOSTNAME__
12738 - name: interface-name
12740 description: Name that identifies the link aggregate interface
12743 example: __INTERFACE-NAME__
12744 - name: interface-name
12746 description: Name given to the interface
12749 example: __INTERFACE-NAME__
12750 - name: vlan-interface
12752 description: String that identifies the interface
12755 example: __VLAN-INTERFACE__
12756 - name: l3-interface-ipv6-address
12758 description: IP address
12761 example: __L3-INTERFACE-IPV6-ADDRESS__
12764 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12767 $ref: "#/definitions/relationship"
12770 - CloudInfrastructure
12771 summary: delete an existing relationship
12772 description: delete an existing relationship
12773 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12782 description: Response codes found in [response codes](https://wiki.onap.org/).
12786 description: Value from executing hostname on the compute node.
12789 example: __HOSTNAME__
12790 - name: interface-name
12792 description: Name that identifies the link aggregate interface
12795 example: __INTERFACE-NAME__
12796 - name: interface-name
12798 description: Name given to the interface
12801 example: __INTERFACE-NAME__
12802 - name: vlan-interface
12804 description: String that identifies the interface
12807 example: __VLAN-INTERFACE__
12808 - name: l3-interface-ipv6-address
12810 description: IP address
12813 example: __L3-INTERFACE-IPV6-ADDRESS__
12814 /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}:
12817 - CloudInfrastructure
12818 summary: returns l3-interface-ipv6-address-list
12819 description: returns l3-interface-ipv6-address-list
12820 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12826 description: successful operation
12828 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12830 description: Response codes found in [response codes](https://wiki.onap.org/).
12834 description: Value from executing hostname on the compute node.
12837 example: __HOSTNAME__
12838 - name: interface-name
12840 description: Name that identifies the link aggregate interface
12843 example: __INTERFACE-NAME__
12844 - name: interface-name
12846 description: Name given to the interface
12849 example: __INTERFACE-NAME__
12850 - name: vlan-interface
12852 description: String that identifies the interface
12855 example: __VLAN-INTERFACE__
12856 - name: l3-interface-ipv6-address
12858 description: IP address
12861 example: __L3-INTERFACE-IPV6-ADDRESS__
12864 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12869 description: ID of Pserver
12876 - name: pserver-name2
12878 description: alternative pserver name
12881 - name: interface-id
12883 description: ID of interface
12886 - name: interface-role
12888 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12891 - name: interface-id
12893 description: ID of interface
12898 description: MAC address for the interface
12901 - name: network-name
12903 description: Name of the network
12906 - name: vlan-id-inner
12908 description: Inner VLAN tag
12914 description: This indicates the customers VPN ID associated with this vlan
12917 - name: vlan-id-inner
12919 description: Inner VLAN tag
12923 - name: neutron-network-id
12925 description: Neutron network id of the interface that address belongs to
12928 - name: neutron-subnet-id
12930 description: Neutron id of subnet that address belongs to
12935 - CloudInfrastructure
12936 summary: create or update an existing l3-interface-ipv6-address-list
12938 Create or update an existing l3-interface-ipv6-address-list.
12940 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12941 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12950 description: Response codes found in [response codes](https://wiki.onap.org/).
12954 description: Value from executing hostname on the compute node.
12957 example: __HOSTNAME__
12958 - name: interface-name
12960 description: Name that identifies the link aggregate interface
12963 example: __INTERFACE-NAME__
12964 - name: interface-name
12966 description: Name given to the interface
12969 example: __INTERFACE-NAME__
12970 - name: vlan-interface
12972 description: String that identifies the interface
12975 example: __VLAN-INTERFACE__
12976 - name: l3-interface-ipv6-address
12978 description: IP address
12981 example: __L3-INTERFACE-IPV6-ADDRESS__
12984 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12987 $ref: "#/definitions/l3-interface-ipv6-address-list"
12990 - CloudInfrastructure
12991 summary: update an existing l3-interface-ipv6-address-list
12993 Update an existing l3-interface-ipv6-address-list
12995 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12996 The PUT operation will entirely replace an existing object.
12997 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12999 Other differences between PUT and PATCH are:
13001 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13002 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13003 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13004 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13013 description: Response codes found in [response codes](https://wiki.onap.org/).
13017 description: Value from executing hostname on the compute node.
13020 example: __HOSTNAME__
13021 - name: interface-name
13023 description: Name that identifies the link aggregate interface
13026 example: __INTERFACE-NAME__
13027 - name: interface-name
13029 description: Name given to the interface
13032 example: __INTERFACE-NAME__
13033 - name: vlan-interface
13035 description: String that identifies the interface
13038 example: __VLAN-INTERFACE__
13039 - name: l3-interface-ipv6-address
13041 description: IP address
13044 example: __L3-INTERFACE-IPV6-ADDRESS__
13047 description: l3-interface-ipv6-address-list object that needs to be created or updated.
13050 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13053 - CloudInfrastructure
13054 summary: delete an existing l3-interface-ipv6-address-list
13055 description: delete an existing l3-interface-ipv6-address-list
13056 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13065 description: Response codes found in [response codes](https://wiki.onap.org/).
13069 description: Value from executing hostname on the compute node.
13072 example: __HOSTNAME__
13073 - name: interface-name
13075 description: Name that identifies the link aggregate interface
13078 example: __INTERFACE-NAME__
13079 - name: interface-name
13081 description: Name given to the interface
13084 example: __INTERFACE-NAME__
13085 - name: vlan-interface
13087 description: String that identifies the interface
13090 example: __VLAN-INTERFACE__
13091 - name: l3-interface-ipv6-address
13093 description: IP address
13096 example: __L3-INTERFACE-IPV6-ADDRESS__
13097 - name: resource-version
13099 description: resource-version for concurrency
13102 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
13105 - CloudInfrastructure
13106 summary: returns vlan
13107 description: returns vlan
13108 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13114 description: successful operation
13116 $ref: "#/getDefinitions/vlan"
13118 description: Response codes found in [response codes](https://wiki.onap.org/).
13122 description: Value from executing hostname on the compute node.
13125 example: __HOSTNAME__
13126 - name: interface-name
13128 description: Name that identifies the link aggregate interface
13131 example: __INTERFACE-NAME__
13132 - name: interface-name
13134 description: Name given to the interface
13137 example: __INTERFACE-NAME__
13138 - name: vlan-interface
13140 description: String that identifies the interface
13143 example: __VLAN-INTERFACE__
13146 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13151 description: ID of Pserver
13158 - name: pserver-name2
13160 description: alternative pserver name
13163 - name: interface-id
13165 description: ID of interface
13168 - name: interface-role
13170 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13173 - name: interface-id
13175 description: ID of interface
13180 description: MAC address for the interface
13183 - name: network-name
13185 description: Name of the network
13188 - name: vlan-id-inner
13190 description: Inner VLAN tag
13196 description: This indicates the customers VPN ID associated with this vlan
13201 - CloudInfrastructure
13202 summary: create or update an existing vlan
13204 Create or update an existing vlan.
13206 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13207 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13216 description: Response codes found in [response codes](https://wiki.onap.org/).
13220 description: Value from executing hostname on the compute node.
13223 example: __HOSTNAME__
13224 - name: interface-name
13226 description: Name that identifies the link aggregate interface
13229 example: __INTERFACE-NAME__
13230 - name: interface-name
13232 description: Name given to the interface
13235 example: __INTERFACE-NAME__
13236 - name: vlan-interface
13238 description: String that identifies the interface
13241 example: __VLAN-INTERFACE__
13244 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
13247 $ref: "#/definitions/vlan"
13250 - CloudInfrastructure
13251 summary: update an existing vlan
13253 Update an existing vlan
13255 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13256 The PUT operation will entirely replace an existing object.
13257 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13259 Other differences between PUT and PATCH are:
13261 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13262 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13263 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13264 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13273 description: Response codes found in [response codes](https://wiki.onap.org/).
13277 description: Value from executing hostname on the compute node.
13280 example: __HOSTNAME__
13281 - name: interface-name
13283 description: Name that identifies the link aggregate interface
13286 example: __INTERFACE-NAME__
13287 - name: interface-name
13289 description: Name given to the interface
13292 example: __INTERFACE-NAME__
13293 - name: vlan-interface
13295 description: String that identifies the interface
13298 example: __VLAN-INTERFACE__
13301 description: vlan object that needs to be created or updated.
13304 $ref: "#/patchDefinitions/vlan"
13307 - CloudInfrastructure
13308 summary: delete an existing vlan
13309 description: delete an existing vlan
13310 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13319 description: Response codes found in [response codes](https://wiki.onap.org/).
13323 description: Value from executing hostname on the compute node.
13326 example: __HOSTNAME__
13327 - name: interface-name
13329 description: Name that identifies the link aggregate interface
13332 example: __INTERFACE-NAME__
13333 - name: interface-name
13335 description: Name given to the interface
13338 example: __INTERFACE-NAME__
13339 - name: vlan-interface
13341 description: String that identifies the interface
13344 example: __VLAN-INTERFACE__
13345 - name: resource-version
13347 description: resource-version for concurrency
13350 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
13353 - CloudInfrastructure
13354 summary: returns vlans
13355 description: returns vlans
13356 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
13362 description: successful operation
13364 $ref: "#/getDefinitions/vlans"
13366 description: Response codes found in [response codes](https://wiki.onap.org/).
13370 description: Value from executing hostname on the compute node.
13373 example: __HOSTNAME__
13374 - name: interface-name
13376 description: Name that identifies the link aggregate interface
13379 example: __INTERFACE-NAME__
13380 - name: interface-name
13382 description: Name given to the interface
13385 example: __INTERFACE-NAME__
13388 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13393 description: ID of Pserver
13400 - name: pserver-name2
13402 description: alternative pserver name
13405 - name: interface-id
13407 description: ID of interface
13410 - name: interface-role
13412 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13415 - name: interface-id
13417 description: ID of interface
13422 description: MAC address for the interface
13425 - name: network-name
13427 description: Name of the network
13430 /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:
13433 - CloudInfrastructure
13434 summary: see node definition for valid relationships
13435 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
13444 description: Response codes found in [response codes](https://wiki.onap.org/).
13448 description: Value from executing hostname on the compute node.
13451 example: __HOSTNAME__
13452 - name: interface-name
13454 description: Name that identifies the link aggregate interface
13457 example: __INTERFACE-NAME__
13458 - name: interface-name
13460 description: Name given to the interface
13463 example: __INTERFACE-NAME__
13466 description: PCI ID used to identify the sriov-vf
13469 example: __PCI-ID__
13472 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
13475 $ref: "#/definitions/relationship"
13478 - CloudInfrastructure
13479 summary: delete an existing relationship
13480 description: delete an existing relationship
13481 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
13490 description: Response codes found in [response codes](https://wiki.onap.org/).
13494 description: Value from executing hostname on the compute node.
13497 example: __HOSTNAME__
13498 - name: interface-name
13500 description: Name that identifies the link aggregate interface
13503 example: __INTERFACE-NAME__
13504 - name: interface-name
13506 description: Name given to the interface
13509 example: __INTERFACE-NAME__
13512 description: PCI ID used to identify the sriov-vf
13515 example: __PCI-ID__
13516 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
13519 - CloudInfrastructure
13520 summary: returns sriov-vf
13521 description: returns sriov-vf
13522 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13528 description: successful operation
13530 $ref: "#/getDefinitions/sriov-vf"
13532 description: Response codes found in [response codes](https://wiki.onap.org/).
13536 description: Value from executing hostname on the compute node.
13539 example: __HOSTNAME__
13540 - name: interface-name
13542 description: Name that identifies the link aggregate interface
13545 example: __INTERFACE-NAME__
13546 - name: interface-name
13548 description: Name given to the interface
13551 example: __INTERFACE-NAME__
13554 description: PCI ID used to identify the sriov-vf
13557 example: __PCI-ID__
13560 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13565 description: ID of Pserver
13572 - name: pserver-name2
13574 description: alternative pserver name
13577 - name: interface-id
13579 description: ID of interface
13582 - name: interface-role
13584 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13587 - name: interface-id
13589 description: ID of interface
13594 description: MAC address for the interface
13597 - name: network-name
13599 description: Name of the network
13602 - name: vf-vlan-filter
13604 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
13607 - name: vf-mac-filter
13609 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
13612 - name: vf-vlan-strip
13614 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
13617 - name: neutron-network-id
13619 description: Neutron network id of the interface
13624 - CloudInfrastructure
13625 summary: create or update an existing sriov-vf
13627 Create or update an existing sriov-vf.
13629 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13630 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13639 description: Response codes found in [response codes](https://wiki.onap.org/).
13643 description: Value from executing hostname on the compute node.
13646 example: __HOSTNAME__
13647 - name: interface-name
13649 description: Name that identifies the link aggregate interface
13652 example: __INTERFACE-NAME__
13653 - name: interface-name
13655 description: Name given to the interface
13658 example: __INTERFACE-NAME__
13661 description: PCI ID used to identify the sriov-vf
13664 example: __PCI-ID__
13667 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
13670 $ref: "#/definitions/sriov-vf"
13673 - CloudInfrastructure
13674 summary: update an existing sriov-vf
13676 Update an existing sriov-vf
13678 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13679 The PUT operation will entirely replace an existing object.
13680 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13682 Other differences between PUT and PATCH are:
13684 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13685 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13686 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13687 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13696 description: Response codes found in [response codes](https://wiki.onap.org/).
13700 description: Value from executing hostname on the compute node.
13703 example: __HOSTNAME__
13704 - name: interface-name
13706 description: Name that identifies the link aggregate interface
13709 example: __INTERFACE-NAME__
13710 - name: interface-name
13712 description: Name given to the interface
13715 example: __INTERFACE-NAME__
13718 description: PCI ID used to identify the sriov-vf
13721 example: __PCI-ID__
13724 description: sriov-vf object that needs to be created or updated.
13727 $ref: "#/patchDefinitions/sriov-vf"
13730 - CloudInfrastructure
13731 summary: delete an existing sriov-vf
13732 description: delete an existing sriov-vf
13733 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13742 description: Response codes found in [response codes](https://wiki.onap.org/).
13746 description: Value from executing hostname on the compute node.
13749 example: __HOSTNAME__
13750 - name: interface-name
13752 description: Name that identifies the link aggregate interface
13755 example: __INTERFACE-NAME__
13756 - name: interface-name
13758 description: Name given to the interface
13761 example: __INTERFACE-NAME__
13764 description: PCI ID used to identify the sriov-vf
13767 example: __PCI-ID__
13768 - name: resource-version
13770 description: resource-version for concurrency
13773 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
13776 - CloudInfrastructure
13777 summary: returns sriov-vfs
13778 description: returns sriov-vfs
13779 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
13785 description: successful operation
13787 $ref: "#/getDefinitions/sriov-vfs"
13789 description: Response codes found in [response codes](https://wiki.onap.org/).
13793 description: Value from executing hostname on the compute node.
13796 example: __HOSTNAME__
13797 - name: interface-name
13799 description: Name that identifies the link aggregate interface
13802 example: __INTERFACE-NAME__
13803 - name: interface-name
13805 description: Name given to the interface
13808 example: __INTERFACE-NAME__
13811 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13816 description: ID of Pserver
13823 - name: pserver-name2
13825 description: alternative pserver name
13828 - name: interface-id
13830 description: ID of interface
13833 - name: interface-role
13835 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13838 - name: interface-id
13840 description: ID of interface
13845 description: MAC address for the interface
13848 - name: network-name
13850 description: Name of the network
13853 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
13856 - CloudInfrastructure
13857 summary: see node definition for valid relationships
13858 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13867 description: Response codes found in [response codes](https://wiki.onap.org/).
13871 description: Value from executing hostname on the compute node.
13874 example: __HOSTNAME__
13875 - name: interface-name
13877 description: Name that identifies the link aggregate interface
13880 example: __INTERFACE-NAME__
13881 - name: interface-name
13883 description: Name given to the interface
13886 example: __INTERFACE-NAME__
13889 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13892 $ref: "#/definitions/relationship"
13895 - CloudInfrastructure
13896 summary: delete an existing relationship
13897 description: delete an existing relationship
13898 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13907 description: Response codes found in [response codes](https://wiki.onap.org/).
13911 description: Value from executing hostname on the compute node.
13914 example: __HOSTNAME__
13915 - name: interface-name
13917 description: Name that identifies the link aggregate interface
13920 example: __INTERFACE-NAME__
13921 - name: interface-name
13923 description: Name given to the interface
13926 example: __INTERFACE-NAME__
13927 /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:
13930 - CloudInfrastructure
13931 summary: see node definition for valid relationships
13932 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13941 description: Response codes found in [response codes](https://wiki.onap.org/).
13945 description: Value from executing hostname on the compute node.
13948 example: __HOSTNAME__
13949 - name: interface-name
13951 description: Name that identifies the link aggregate interface
13954 example: __INTERFACE-NAME__
13955 - name: interface-name
13957 description: Name given to the interface
13960 example: __INTERFACE-NAME__
13961 - name: l3-interface-ipv4-address
13963 description: IP address
13966 example: __L3-INTERFACE-IPV4-ADDRESS__
13969 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13972 $ref: "#/definitions/relationship"
13975 - CloudInfrastructure
13976 summary: delete an existing relationship
13977 description: delete an existing relationship
13978 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13987 description: Response codes found in [response codes](https://wiki.onap.org/).
13991 description: Value from executing hostname on the compute node.
13994 example: __HOSTNAME__
13995 - name: interface-name
13997 description: Name that identifies the link aggregate interface
14000 example: __INTERFACE-NAME__
14001 - name: interface-name
14003 description: Name given to the interface
14006 example: __INTERFACE-NAME__
14007 - name: l3-interface-ipv4-address
14009 description: IP address
14012 example: __L3-INTERFACE-IPV4-ADDRESS__
14013 /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}:
14016 - CloudInfrastructure
14017 summary: returns l3-interface-ipv4-address-list
14018 description: returns l3-interface-ipv4-address-list
14019 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14025 description: successful operation
14027 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
14029 description: Response codes found in [response codes](https://wiki.onap.org/).
14033 description: Value from executing hostname on the compute node.
14036 example: __HOSTNAME__
14037 - name: interface-name
14039 description: Name that identifies the link aggregate interface
14042 example: __INTERFACE-NAME__
14043 - name: interface-name
14045 description: Name given to the interface
14048 example: __INTERFACE-NAME__
14049 - name: l3-interface-ipv4-address
14051 description: IP address
14054 example: __L3-INTERFACE-IPV4-ADDRESS__
14057 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
14062 description: ID of Pserver
14069 - name: pserver-name2
14071 description: alternative pserver name
14074 - name: interface-id
14076 description: ID of interface
14079 - name: interface-role
14081 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14084 - name: interface-id
14086 description: ID of interface
14091 description: MAC address for the interface
14094 - name: network-name
14096 description: Name of the network
14099 - name: vlan-id-inner
14101 description: Inner VLAN tag
14105 - name: neutron-network-id
14107 description: Neutron network id of the interface that address belongs to
14110 - name: neutron-subnet-id
14112 description: Neutron id of subnet that address belongs to
14117 - CloudInfrastructure
14118 summary: create or update an existing l3-interface-ipv4-address-list
14120 Create or update an existing l3-interface-ipv4-address-list.
14122 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14123 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14132 description: Response codes found in [response codes](https://wiki.onap.org/).
14136 description: Value from executing hostname on the compute node.
14139 example: __HOSTNAME__
14140 - name: interface-name
14142 description: Name that identifies the link aggregate interface
14145 example: __INTERFACE-NAME__
14146 - name: interface-name
14148 description: Name given to the interface
14151 example: __INTERFACE-NAME__
14152 - name: l3-interface-ipv4-address
14154 description: IP address
14157 example: __L3-INTERFACE-IPV4-ADDRESS__
14160 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
14163 $ref: "#/definitions/l3-interface-ipv4-address-list"
14166 - CloudInfrastructure
14167 summary: update an existing l3-interface-ipv4-address-list
14169 Update an existing l3-interface-ipv4-address-list
14171 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14172 The PUT operation will entirely replace an existing object.
14173 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14175 Other differences between PUT and PATCH are:
14177 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14178 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14179 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14180 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14189 description: Response codes found in [response codes](https://wiki.onap.org/).
14193 description: Value from executing hostname on the compute node.
14196 example: __HOSTNAME__
14197 - name: interface-name
14199 description: Name that identifies the link aggregate interface
14202 example: __INTERFACE-NAME__
14203 - name: interface-name
14205 description: Name given to the interface
14208 example: __INTERFACE-NAME__
14209 - name: l3-interface-ipv4-address
14211 description: IP address
14214 example: __L3-INTERFACE-IPV4-ADDRESS__
14217 description: l3-interface-ipv4-address-list object that needs to be created or updated.
14220 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
14223 - CloudInfrastructure
14224 summary: delete an existing l3-interface-ipv4-address-list
14225 description: delete an existing l3-interface-ipv4-address-list
14226 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14235 description: Response codes found in [response codes](https://wiki.onap.org/).
14239 description: Value from executing hostname on the compute node.
14242 example: __HOSTNAME__
14243 - name: interface-name
14245 description: Name that identifies the link aggregate interface
14248 example: __INTERFACE-NAME__
14249 - name: interface-name
14251 description: Name given to the interface
14254 example: __INTERFACE-NAME__
14255 - name: l3-interface-ipv4-address
14257 description: IP address
14260 example: __L3-INTERFACE-IPV4-ADDRESS__
14261 - name: resource-version
14263 description: resource-version for concurrency
14266 /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:
14269 - CloudInfrastructure
14270 summary: see node definition for valid relationships
14271 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
14280 description: Response codes found in [response codes](https://wiki.onap.org/).
14284 description: Value from executing hostname on the compute node.
14287 example: __HOSTNAME__
14288 - name: interface-name
14290 description: Name that identifies the link aggregate interface
14293 example: __INTERFACE-NAME__
14294 - name: interface-name
14296 description: Name given to the interface
14299 example: __INTERFACE-NAME__
14300 - name: l3-interface-ipv6-address
14302 description: IP address
14305 example: __L3-INTERFACE-IPV6-ADDRESS__
14308 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
14311 $ref: "#/definitions/relationship"
14314 - CloudInfrastructure
14315 summary: delete an existing relationship
14316 description: delete an existing relationship
14317 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
14326 description: Response codes found in [response codes](https://wiki.onap.org/).
14330 description: Value from executing hostname on the compute node.
14333 example: __HOSTNAME__
14334 - name: interface-name
14336 description: Name that identifies the link aggregate interface
14339 example: __INTERFACE-NAME__
14340 - name: interface-name
14342 description: Name given to the interface
14345 example: __INTERFACE-NAME__
14346 - name: l3-interface-ipv6-address
14348 description: IP address
14351 example: __L3-INTERFACE-IPV6-ADDRESS__
14352 /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}:
14355 - CloudInfrastructure
14356 summary: returns l3-interface-ipv6-address-list
14357 description: returns l3-interface-ipv6-address-list
14358 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14364 description: successful operation
14366 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
14368 description: Response codes found in [response codes](https://wiki.onap.org/).
14372 description: Value from executing hostname on the compute node.
14375 example: __HOSTNAME__
14376 - name: interface-name
14378 description: Name that identifies the link aggregate interface
14381 example: __INTERFACE-NAME__
14382 - name: interface-name
14384 description: Name given to the interface
14387 example: __INTERFACE-NAME__
14388 - name: l3-interface-ipv6-address
14390 description: IP address
14393 example: __L3-INTERFACE-IPV6-ADDRESS__
14396 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
14401 description: ID of Pserver
14408 - name: pserver-name2
14410 description: alternative pserver name
14413 - name: interface-id
14415 description: ID of interface
14418 - name: interface-role
14420 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14423 - name: interface-id
14425 description: ID of interface
14430 description: MAC address for the interface
14433 - name: network-name
14435 description: Name of the network
14438 - name: vlan-id-inner
14440 description: Inner VLAN tag
14444 - name: neutron-network-id
14446 description: Neutron network id of the interface that address belongs to
14449 - name: neutron-subnet-id
14451 description: Neutron id of subnet that address belongs to
14456 - CloudInfrastructure
14457 summary: create or update an existing l3-interface-ipv6-address-list
14459 Create or update an existing l3-interface-ipv6-address-list.
14461 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14462 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14471 description: Response codes found in [response codes](https://wiki.onap.org/).
14475 description: Value from executing hostname on the compute node.
14478 example: __HOSTNAME__
14479 - name: interface-name
14481 description: Name that identifies the link aggregate interface
14484 example: __INTERFACE-NAME__
14485 - name: interface-name
14487 description: Name given to the interface
14490 example: __INTERFACE-NAME__
14491 - name: l3-interface-ipv6-address
14493 description: IP address
14496 example: __L3-INTERFACE-IPV6-ADDRESS__
14499 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
14502 $ref: "#/definitions/l3-interface-ipv6-address-list"
14505 - CloudInfrastructure
14506 summary: update an existing l3-interface-ipv6-address-list
14508 Update an existing l3-interface-ipv6-address-list
14510 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14511 The PUT operation will entirely replace an existing object.
14512 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14514 Other differences between PUT and PATCH are:
14516 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14517 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14518 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14519 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14528 description: Response codes found in [response codes](https://wiki.onap.org/).
14532 description: Value from executing hostname on the compute node.
14535 example: __HOSTNAME__
14536 - name: interface-name
14538 description: Name that identifies the link aggregate interface
14541 example: __INTERFACE-NAME__
14542 - name: interface-name
14544 description: Name given to the interface
14547 example: __INTERFACE-NAME__
14548 - name: l3-interface-ipv6-address
14550 description: IP address
14553 example: __L3-INTERFACE-IPV6-ADDRESS__
14556 description: l3-interface-ipv6-address-list object that needs to be created or updated.
14559 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
14562 - CloudInfrastructure
14563 summary: delete an existing l3-interface-ipv6-address-list
14564 description: delete an existing l3-interface-ipv6-address-list
14565 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14574 description: Response codes found in [response codes](https://wiki.onap.org/).
14578 description: Value from executing hostname on the compute node.
14581 example: __HOSTNAME__
14582 - name: interface-name
14584 description: Name that identifies the link aggregate interface
14587 example: __INTERFACE-NAME__
14588 - name: interface-name
14590 description: Name given to the interface
14593 example: __INTERFACE-NAME__
14594 - name: l3-interface-ipv6-address
14596 description: IP address
14599 example: __L3-INTERFACE-IPV6-ADDRESS__
14600 - name: resource-version
14602 description: resource-version for concurrency
14605 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
14608 - CloudInfrastructure
14609 summary: returns l-interface
14610 description: returns l-interface
14611 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14617 description: successful operation
14619 $ref: "#/getDefinitions/l-interface"
14621 description: Response codes found in [response codes](https://wiki.onap.org/).
14625 description: Value from executing hostname on the compute node.
14628 example: __HOSTNAME__
14629 - name: interface-name
14631 description: Name that identifies the link aggregate interface
14634 example: __INTERFACE-NAME__
14635 - name: interface-name
14637 description: Name given to the interface
14640 example: __INTERFACE-NAME__
14643 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
14648 description: ID of Pserver
14655 - name: pserver-name2
14657 description: alternative pserver name
14660 - name: interface-id
14662 description: ID of interface
14665 - name: interface-role
14667 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14670 - name: interface-id
14672 description: ID of interface
14677 description: MAC address for the interface
14680 - name: network-name
14682 description: Name of the network
14687 - CloudInfrastructure
14688 summary: create or update an existing l-interface
14690 Create or update an existing l-interface.
14692 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14693 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14702 description: Response codes found in [response codes](https://wiki.onap.org/).
14706 description: Value from executing hostname on the compute node.
14709 example: __HOSTNAME__
14710 - name: interface-name
14712 description: Name that identifies the link aggregate interface
14715 example: __INTERFACE-NAME__
14716 - name: interface-name
14718 description: Name given to the interface
14721 example: __INTERFACE-NAME__
14724 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
14727 $ref: "#/definitions/l-interface"
14730 - CloudInfrastructure
14731 summary: update an existing l-interface
14733 Update an existing l-interface
14735 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14736 The PUT operation will entirely replace an existing object.
14737 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14739 Other differences between PUT and PATCH are:
14741 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14742 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14743 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14744 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14753 description: Response codes found in [response codes](https://wiki.onap.org/).
14757 description: Value from executing hostname on the compute node.
14760 example: __HOSTNAME__
14761 - name: interface-name
14763 description: Name that identifies the link aggregate interface
14766 example: __INTERFACE-NAME__
14767 - name: interface-name
14769 description: Name given to the interface
14772 example: __INTERFACE-NAME__
14775 description: l-interface object that needs to be created or updated.
14778 $ref: "#/patchDefinitions/l-interface"
14781 - CloudInfrastructure
14782 summary: delete an existing l-interface
14783 description: delete an existing l-interface
14784 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14793 description: Response codes found in [response codes](https://wiki.onap.org/).
14797 description: Value from executing hostname on the compute node.
14800 example: __HOSTNAME__
14801 - name: interface-name
14803 description: Name that identifies the link aggregate interface
14806 example: __INTERFACE-NAME__
14807 - name: interface-name
14809 description: Name given to the interface
14812 example: __INTERFACE-NAME__
14813 - name: resource-version
14815 description: resource-version for concurrency
14818 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
14821 - CloudInfrastructure
14822 summary: returns l-interfaces
14823 description: returns l-interfaces
14824 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
14830 description: successful operation
14832 $ref: "#/getDefinitions/l-interfaces"
14834 description: Response codes found in [response codes](https://wiki.onap.org/).
14838 description: Value from executing hostname on the compute node.
14841 example: __HOSTNAME__
14842 - name: interface-name
14844 description: Name that identifies the link aggregate interface
14847 example: __INTERFACE-NAME__
14850 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
14855 description: ID of Pserver
14862 - name: pserver-name2
14864 description: alternative pserver name
14867 - name: interface-id
14869 description: ID of interface
14872 - name: interface-role
14874 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14877 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
14880 - CloudInfrastructure
14881 summary: returns lag-interface
14882 description: returns lag-interface
14883 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
14889 description: successful operation
14891 $ref: "#/getDefinitions/lag-interface"
14893 description: Response codes found in [response codes](https://wiki.onap.org/).
14897 description: Value from executing hostname on the compute node.
14900 example: __HOSTNAME__
14901 - name: interface-name
14903 description: Name that identifies the link aggregate interface
14906 example: __INTERFACE-NAME__
14909 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
14914 description: ID of Pserver
14921 - name: pserver-name2
14923 description: alternative pserver name
14926 - name: interface-id
14928 description: ID of interface
14931 - name: interface-role
14933 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14938 - CloudInfrastructure
14939 summary: create or update an existing lag-interface
14941 Create or update an existing lag-interface.
14943 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14944 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14953 description: Response codes found in [response codes](https://wiki.onap.org/).
14957 description: Value from executing hostname on the compute node.
14960 example: __HOSTNAME__
14961 - name: interface-name
14963 description: Name that identifies the link aggregate interface
14966 example: __INTERFACE-NAME__
14969 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
14972 $ref: "#/definitions/lag-interface"
14975 - CloudInfrastructure
14976 summary: update an existing lag-interface
14978 Update an existing lag-interface
14980 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14981 The PUT operation will entirely replace an existing object.
14982 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14984 Other differences between PUT and PATCH are:
14986 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14987 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14988 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14989 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14998 description: Response codes found in [response codes](https://wiki.onap.org/).
15002 description: Value from executing hostname on the compute node.
15005 example: __HOSTNAME__
15006 - name: interface-name
15008 description: Name that identifies the link aggregate interface
15011 example: __INTERFACE-NAME__
15014 description: lag-interface object that needs to be created or updated.
15017 $ref: "#/patchDefinitions/lag-interface"
15020 - CloudInfrastructure
15021 summary: delete an existing lag-interface
15022 description: delete an existing lag-interface
15023 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
15032 description: Response codes found in [response codes](https://wiki.onap.org/).
15036 description: Value from executing hostname on the compute node.
15039 example: __HOSTNAME__
15040 - name: interface-name
15042 description: Name that identifies the link aggregate interface
15045 example: __INTERFACE-NAME__
15046 - name: resource-version
15048 description: resource-version for concurrency
15051 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
15054 - CloudInfrastructure
15055 summary: returns lag-interfaces
15056 description: returns lag-interfaces
15057 operationId: getCloudInfrastructurePserversPserverLagInterfaces
15063 description: successful operation
15065 $ref: "#/getDefinitions/lag-interfaces"
15067 description: Response codes found in [response codes](https://wiki.onap.org/).
15071 description: Value from executing hostname on the compute node.
15074 example: __HOSTNAME__
15077 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
15082 description: ID of Pserver
15089 - name: pserver-name2
15091 description: alternative pserver name
15094 /cloud-infrastructure/pservers/pserver/{hostname}:
15097 - CloudInfrastructure
15098 summary: returns pserver
15099 description: returns pserver
15100 operationId: getCloudInfrastructurePserversPserver
15106 description: successful operation
15108 $ref: "#/getDefinitions/pserver"
15110 description: Response codes found in [response codes](https://wiki.onap.org/).
15114 description: Value from executing hostname on the compute node.
15117 example: __HOSTNAME__
15120 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
15125 description: ID of Pserver
15132 - name: pserver-name2
15134 description: alternative pserver name
15139 - CloudInfrastructure
15140 summary: create or update an existing pserver
15142 Create or update an existing pserver.
15144 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15145 operationId: createOrUpdateCloudInfrastructurePserversPserver
15154 description: Response codes found in [response codes](https://wiki.onap.org/).
15158 description: Value from executing hostname on the compute node.
15161 example: __HOSTNAME__
15164 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)
15167 $ref: "#/definitions/pserver"
15170 - CloudInfrastructure
15171 summary: update an existing pserver
15173 Update an existing pserver
15175 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15176 The PUT operation will entirely replace an existing object.
15177 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15179 Other differences between PUT and PATCH are:
15181 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15182 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15183 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15184 operationId: UpdateCloudInfrastructurePserversPserver
15193 description: Response codes found in [response codes](https://wiki.onap.org/).
15197 description: Value from executing hostname on the compute node.
15200 example: __HOSTNAME__
15203 description: pserver object that needs to be created or updated.
15206 $ref: "#/patchDefinitions/pserver"
15209 - CloudInfrastructure
15210 summary: delete an existing pserver
15211 description: delete an existing pserver
15212 operationId: deleteCloudInfrastructurePserversPserver
15221 description: Response codes found in [response codes](https://wiki.onap.org/).
15225 description: Value from executing hostname on the compute node.
15228 example: __HOSTNAME__
15229 - name: resource-version
15231 description: resource-version for concurrency
15234 /cloud-infrastructure/pservers:
15237 - CloudInfrastructure
15238 summary: returns pservers
15239 description: returns pservers
15240 operationId: getCloudInfrastructurePservers
15246 description: successful operation
15248 $ref: "#/getDefinitions/pservers"
15250 description: Response codes found in [response codes](https://wiki.onap.org/).
15251 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
15254 - CloudInfrastructure
15255 summary: see node definition for valid relationships
15256 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
15265 description: Response codes found in [response codes](https://wiki.onap.org/).
15269 description: Unique ID of the vdc
15272 example: __VDC-ID__
15275 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
15278 $ref: "#/definitions/relationship"
15281 - CloudInfrastructure
15282 summary: delete an existing relationship
15283 description: delete an existing relationship
15284 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
15293 description: Response codes found in [response codes](https://wiki.onap.org/).
15297 description: Unique ID of the vdc
15300 example: __VDC-ID__
15301 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
15304 - CloudInfrastructure
15305 summary: returns virtual-data-center
15306 description: returns virtual-data-center
15307 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
15313 description: successful operation
15315 $ref: "#/getDefinitions/virtual-data-center"
15317 description: Response codes found in [response codes](https://wiki.onap.org/).
15321 description: Unique ID of the vdc
15324 example: __VDC-ID__
15327 description: Name of the virtual data center
15332 - CloudInfrastructure
15333 summary: create or update an existing virtual-data-center
15335 Create or update an existing virtual-data-center.
15337 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15338 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
15347 description: Response codes found in [response codes](https://wiki.onap.org/).
15351 description: Unique ID of the vdc
15354 example: __VDC-ID__
15357 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
15360 $ref: "#/definitions/virtual-data-center"
15363 - CloudInfrastructure
15364 summary: update an existing virtual-data-center
15366 Update an existing virtual-data-center
15368 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15369 The PUT operation will entirely replace an existing object.
15370 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15372 Other differences between PUT and PATCH are:
15374 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15375 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15376 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15377 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
15386 description: Response codes found in [response codes](https://wiki.onap.org/).
15390 description: Unique ID of the vdc
15393 example: __VDC-ID__
15396 description: virtual-data-center object that needs to be created or updated.
15399 $ref: "#/patchDefinitions/virtual-data-center"
15402 - CloudInfrastructure
15403 summary: delete an existing virtual-data-center
15404 description: delete an existing virtual-data-center
15405 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
15414 description: Response codes found in [response codes](https://wiki.onap.org/).
15418 description: Unique ID of the vdc
15421 example: __VDC-ID__
15422 - name: resource-version
15424 description: resource-version for concurrency
15427 /cloud-infrastructure/virtual-data-centers:
15430 - CloudInfrastructure
15431 summary: returns virtual-data-centers
15432 description: returns virtual-data-centers
15433 operationId: getCloudInfrastructureVirtualDataCenters
15439 description: successful operation
15441 $ref: "#/getDefinitions/virtual-data-centers"
15443 description: Response codes found in [response codes](https://wiki.onap.org/).
15444 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
15448 summary: see node definition for valid relationships
15449 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
15458 description: Response codes found in [response codes](https://wiki.onap.org/).
15460 - name: resource-instance-id
15462 description: Unique id of resource instance.
15465 example: __RESOURCE-INSTANCE-ID__
15468 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)
15471 $ref: "#/definitions/relationship"
15475 summary: delete an existing relationship
15476 description: delete an existing relationship
15477 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
15486 description: Response codes found in [response codes](https://wiki.onap.org/).
15488 - name: resource-instance-id
15490 description: Unique id of resource instance.
15493 example: __RESOURCE-INSTANCE-ID__
15494 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
15498 summary: returns metadatum
15499 description: returns metadatum
15500 operationId: getBusinessConnectorsConnectorMetadataMetadatum
15506 description: successful operation
15508 $ref: "#/getDefinitions/metadatum"
15510 description: Response codes found in [response codes](https://wiki.onap.org/).
15512 - name: resource-instance-id
15514 description: Unique id of resource instance.
15517 example: __RESOURCE-INSTANCE-ID__
15522 example: __METANAME__
15523 - name: model-invariant-id
15525 description: the ASDC model id for this resource or service model.
15528 - name: model-version-id
15530 description: the ASDC model version for this resource or service model.
15533 - name: widget-model-id
15535 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15538 - name: widget-model-version
15540 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15546 summary: create or update an existing metadatum
15548 Create or update an existing metadatum.
15550 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15551 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
15560 description: Response codes found in [response codes](https://wiki.onap.org/).
15562 - name: resource-instance-id
15564 description: Unique id of resource instance.
15567 example: __RESOURCE-INSTANCE-ID__
15572 example: __METANAME__
15575 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnectorMetadataMetadatum.json)
15578 $ref: "#/definitions/metadatum"
15582 summary: update an existing metadatum
15584 Update an existing metadatum
15586 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15587 The PUT operation will entirely replace an existing object.
15588 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15590 Other differences between PUT and PATCH are:
15592 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15593 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15594 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15595 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
15604 description: Response codes found in [response codes](https://wiki.onap.org/).
15606 - name: resource-instance-id
15608 description: Unique id of resource instance.
15611 example: __RESOURCE-INSTANCE-ID__
15616 example: __METANAME__
15619 description: metadatum object that needs to be created or updated.
15622 $ref: "#/patchDefinitions/metadatum"
15626 summary: delete an existing metadatum
15627 description: delete an existing metadatum
15628 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
15637 description: Response codes found in [response codes](https://wiki.onap.org/).
15639 - name: resource-instance-id
15641 description: Unique id of resource instance.
15644 example: __RESOURCE-INSTANCE-ID__
15649 example: __METANAME__
15650 - name: resource-version
15652 description: resource-version for concurrency
15655 /business/connectors/connector/{resource-instance-id}/metadata:
15659 summary: returns metadata
15660 description: returns metadata
15661 operationId: getBusinessConnectorsConnectorMetadata
15667 description: successful operation
15669 $ref: "#/getDefinitions/metadata"
15671 description: Response codes found in [response codes](https://wiki.onap.org/).
15673 - name: resource-instance-id
15675 description: Unique id of resource instance.
15678 example: __RESOURCE-INSTANCE-ID__
15679 - name: model-invariant-id
15681 description: the ASDC model id for this resource or service model.
15684 - name: model-version-id
15686 description: the ASDC model version for this resource or service model.
15689 - name: widget-model-id
15691 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15694 - name: widget-model-version
15696 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15699 /business/connectors/connector/{resource-instance-id}:
15703 summary: returns connector
15704 description: returns connector
15705 operationId: getBusinessConnectorsConnector
15711 description: successful operation
15713 $ref: "#/getDefinitions/connector"
15715 description: Response codes found in [response codes](https://wiki.onap.org/).
15717 - name: resource-instance-id
15719 description: Unique id of resource instance.
15722 example: __RESOURCE-INSTANCE-ID__
15723 - name: model-invariant-id
15725 description: the ASDC model id for this resource or service model.
15728 - name: model-version-id
15730 description: the ASDC model version for this resource or service model.
15733 - name: widget-model-id
15735 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15738 - name: widget-model-version
15740 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15746 summary: create or update an existing connector
15748 Create or update an existing connector.
15750 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15751 operationId: createOrUpdateBusinessConnectorsConnector
15760 description: Response codes found in [response codes](https://wiki.onap.org/).
15762 - name: resource-instance-id
15764 description: Unique id of resource instance.
15767 example: __RESOURCE-INSTANCE-ID__
15770 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)
15773 $ref: "#/definitions/connector"
15777 summary: update an existing connector
15779 Update an existing connector
15781 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15782 The PUT operation will entirely replace an existing object.
15783 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15785 Other differences between PUT and PATCH are:
15787 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15788 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15789 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15790 operationId: UpdateBusinessConnectorsConnector
15799 description: Response codes found in [response codes](https://wiki.onap.org/).
15801 - name: resource-instance-id
15803 description: Unique id of resource instance.
15806 example: __RESOURCE-INSTANCE-ID__
15809 description: connector object that needs to be created or updated.
15812 $ref: "#/patchDefinitions/connector"
15816 summary: delete an existing connector
15817 description: delete an existing connector
15818 operationId: deleteBusinessConnectorsConnector
15827 description: Response codes found in [response codes](https://wiki.onap.org/).
15829 - name: resource-instance-id
15831 description: Unique id of resource instance.
15834 example: __RESOURCE-INSTANCE-ID__
15835 - name: resource-version
15837 description: resource-version for concurrency
15840 /business/connectors:
15844 summary: returns connectors
15845 description: returns connectors
15846 operationId: getBusinessConnectors
15852 description: successful operation
15854 $ref: "#/getDefinitions/connectors"
15856 description: Response codes found in [response codes](https://wiki.onap.org/).
15857 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
15861 summary: see node definition for valid relationships
15862 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15871 description: Response codes found in [response codes](https://wiki.onap.org/).
15873 - name: global-customer-id
15875 description: Global customer id used across ECOMP to uniquely identify customer.
15878 example: __GLOBAL-CUSTOMER-ID__
15879 - name: service-type
15881 description: Value defined by orchestration to identify this service across ECOMP.
15884 example: __SERVICE-TYPE__
15885 - name: service-instance-id
15887 description: Uniquely identifies this instance of a service
15890 example: __SERVICE-INSTANCE-ID__
15893 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
15896 $ref: "#/definitions/relationship"
15900 summary: delete an existing relationship
15901 description: delete an existing relationship
15902 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15911 description: Response codes found in [response codes](https://wiki.onap.org/).
15913 - name: global-customer-id
15915 description: Global customer id used across ECOMP to uniquely identify customer.
15918 example: __GLOBAL-CUSTOMER-ID__
15919 - name: service-type
15921 description: Value defined by orchestration to identify this service across ECOMP.
15924 example: __SERVICE-TYPE__
15925 - name: service-instance-id
15927 description: Uniquely identifies this instance of a service
15930 example: __SERVICE-INSTANCE-ID__
15931 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
15935 summary: returns metadatum
15936 description: returns metadatum
15937 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15943 description: successful operation
15945 $ref: "#/getDefinitions/metadatum"
15947 description: Response codes found in [response codes](https://wiki.onap.org/).
15949 - name: global-customer-id
15951 description: Global customer id used across ECOMP to uniquely identify customer.
15954 example: __GLOBAL-CUSTOMER-ID__
15955 - name: service-type
15957 description: Value defined by orchestration to identify this service across ECOMP.
15960 example: __SERVICE-TYPE__
15961 - name: service-instance-id
15963 description: Uniquely identifies this instance of a service
15966 example: __SERVICE-INSTANCE-ID__
15971 example: __METANAME__
15972 - name: subscriber-name
15974 description: Subscriber name, an alternate way to retrieve a customer.
15977 - name: subscriber-type
15979 description: Subscriber type, a way to provide VID with only the INFRA customers.
15982 - name: service-instance-name
15984 description: This field will store a name assigned to the service-instance.
15987 - name: environment-context
15989 description: This field will store the environment context assigned to the service-instance.
15992 - name: workload-context
15994 description: This field will store the workload context assigned to the service-instance.
15997 - name: model-invariant-id
15999 description: the ASDC model id for this resource or service model.
16002 - name: model-version-id
16004 description: the ASDC model version for this resource or service model.
16007 - name: widget-model-id
16009 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16012 - name: widget-model-version
16014 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16017 - name: service-instance-location-id
16019 description: An identifier that customers assign to the location where this service is being used.
16022 - name: orchestration-status
16024 description: Orchestration status of this service.
16030 summary: create or update an existing metadatum
16032 Create or update an existing metadatum.
16034 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16035 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16044 description: Response codes found in [response codes](https://wiki.onap.org/).
16046 - name: global-customer-id
16048 description: Global customer id used across ECOMP to uniquely identify customer.
16051 example: __GLOBAL-CUSTOMER-ID__
16052 - name: service-type
16054 description: Value defined by orchestration to identify this service across ECOMP.
16057 example: __SERVICE-TYPE__
16058 - name: service-instance-id
16060 description: Uniquely identifies this instance of a service
16063 example: __SERVICE-INSTANCE-ID__
16068 example: __METANAME__
16071 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
16074 $ref: "#/definitions/metadatum"
16078 summary: update an existing metadatum
16080 Update an existing metadatum
16082 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16083 The PUT operation will entirely replace an existing object.
16084 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16086 Other differences between PUT and PATCH are:
16088 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16089 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16090 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16091 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16100 description: Response codes found in [response codes](https://wiki.onap.org/).
16102 - name: global-customer-id
16104 description: Global customer id used across ECOMP to uniquely identify customer.
16107 example: __GLOBAL-CUSTOMER-ID__
16108 - name: service-type
16110 description: Value defined by orchestration to identify this service across ECOMP.
16113 example: __SERVICE-TYPE__
16114 - name: service-instance-id
16116 description: Uniquely identifies this instance of a service
16119 example: __SERVICE-INSTANCE-ID__
16124 example: __METANAME__
16127 description: metadatum object that needs to be created or updated.
16130 $ref: "#/patchDefinitions/metadatum"
16134 summary: delete an existing metadatum
16135 description: delete an existing metadatum
16136 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16145 description: Response codes found in [response codes](https://wiki.onap.org/).
16147 - name: global-customer-id
16149 description: Global customer id used across ECOMP to uniquely identify customer.
16152 example: __GLOBAL-CUSTOMER-ID__
16153 - name: service-type
16155 description: Value defined by orchestration to identify this service across ECOMP.
16158 example: __SERVICE-TYPE__
16159 - name: service-instance-id
16161 description: Uniquely identifies this instance of a service
16164 example: __SERVICE-INSTANCE-ID__
16169 example: __METANAME__
16170 - name: resource-version
16172 description: resource-version for concurrency
16175 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
16179 summary: returns metadata
16180 description: returns metadata
16181 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
16187 description: successful operation
16189 $ref: "#/getDefinitions/metadata"
16191 description: Response codes found in [response codes](https://wiki.onap.org/).
16193 - name: global-customer-id
16195 description: Global customer id used across ECOMP to uniquely identify customer.
16198 example: __GLOBAL-CUSTOMER-ID__
16199 - name: service-type
16201 description: Value defined by orchestration to identify this service across ECOMP.
16204 example: __SERVICE-TYPE__
16205 - name: service-instance-id
16207 description: Uniquely identifies this instance of a service
16210 example: __SERVICE-INSTANCE-ID__
16211 - name: subscriber-name
16213 description: Subscriber name, an alternate way to retrieve a customer.
16216 - name: subscriber-type
16218 description: Subscriber type, a way to provide VID with only the INFRA customers.
16221 - name: service-instance-name
16223 description: This field will store a name assigned to the service-instance.
16226 - name: environment-context
16228 description: This field will store the environment context assigned to the service-instance.
16231 - name: workload-context
16233 description: This field will store the workload context assigned to the service-instance.
16236 - name: model-invariant-id
16238 description: the ASDC model id for this resource or service model.
16241 - name: model-version-id
16243 description: the ASDC model version for this resource or service model.
16246 - name: widget-model-id
16248 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16251 - name: widget-model-version
16253 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16256 - name: service-instance-location-id
16258 description: An identifier that customers assign to the location where this service is being used.
16261 - name: orchestration-status
16263 description: Orchestration status of this service.
16266 /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:
16270 summary: see node definition for valid relationships
16271 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
16280 description: Response codes found in [response codes](https://wiki.onap.org/).
16282 - name: global-customer-id
16284 description: Global customer id used across ECOMP to uniquely identify customer.
16287 example: __GLOBAL-CUSTOMER-ID__
16288 - name: service-type
16290 description: Value defined by orchestration to identify this service across ECOMP.
16293 example: __SERVICE-TYPE__
16294 - name: service-instance-id
16296 description: Uniquely identifies this instance of a service
16299 example: __SERVICE-INSTANCE-ID__
16302 description: Allotted Resource id UUID assigned to this instance.
16308 description: Allotted Resource id UUID assigned to this instance.
16314 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
16317 $ref: "#/definitions/relationship"
16321 summary: delete an existing relationship
16322 description: delete an existing relationship
16323 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
16332 description: Response codes found in [response codes](https://wiki.onap.org/).
16334 - name: global-customer-id
16336 description: Global customer id used across ECOMP to uniquely identify customer.
16339 example: __GLOBAL-CUSTOMER-ID__
16340 - name: service-type
16342 description: Value defined by orchestration to identify this service across ECOMP.
16345 example: __SERVICE-TYPE__
16346 - name: service-instance-id
16348 description: Uniquely identifies this instance of a service
16351 example: __SERVICE-INSTANCE-ID__
16354 description: Allotted Resource id UUID assigned to this instance.
16360 description: Allotted Resource id UUID assigned to this instance.
16364 /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}:
16368 summary: returns tunnel-xconnect
16369 description: returns tunnel-xconnect
16370 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16376 description: successful operation
16378 $ref: "#/getDefinitions/tunnel-xconnect"
16380 description: Response codes found in [response codes](https://wiki.onap.org/).
16382 - name: global-customer-id
16384 description: Global customer id used across ECOMP to uniquely identify customer.
16387 example: __GLOBAL-CUSTOMER-ID__
16388 - name: service-type
16390 description: Value defined by orchestration to identify this service across ECOMP.
16393 example: __SERVICE-TYPE__
16394 - name: service-instance-id
16396 description: Uniquely identifies this instance of a service
16399 example: __SERVICE-INSTANCE-ID__
16402 description: Allotted Resource id UUID assigned to this instance.
16408 description: Allotted Resource id UUID assigned to this instance.
16412 - name: subscriber-name
16414 description: Subscriber name, an alternate way to retrieve a customer.
16417 - name: subscriber-type
16419 description: Subscriber type, a way to provide VID with only the INFRA customers.
16422 - name: service-instance-name
16424 description: This field will store a name assigned to the service-instance.
16427 - name: environment-context
16429 description: This field will store the environment context assigned to the service-instance.
16432 - name: workload-context
16434 description: This field will store the workload context assigned to the service-instance.
16437 - name: model-invariant-id
16439 description: the ASDC model id for this resource or service model.
16442 - name: model-version-id
16444 description: the ASDC model version for this resource or service model.
16447 - name: widget-model-id
16449 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16452 - name: widget-model-version
16454 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16457 - name: service-instance-location-id
16459 description: An identifier that customers assign to the location where this service is being used.
16462 - name: orchestration-status
16464 description: Orchestration status of this service.
16467 - name: model-invariant-id
16469 description: the ASDC model id for this resource or service model.
16472 - name: model-version-id
16474 description: the ASDC model version for this resource or service model.
16479 description: Generic description of the type of allotted resource.
16484 description: role in the network that this resource will be providing.
16490 summary: create or update an existing tunnel-xconnect
16492 Create or update an existing tunnel-xconnect.
16494 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16495 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16504 description: Response codes found in [response codes](https://wiki.onap.org/).
16506 - name: global-customer-id
16508 description: Global customer id used across ECOMP to uniquely identify customer.
16511 example: __GLOBAL-CUSTOMER-ID__
16512 - name: service-type
16514 description: Value defined by orchestration to identify this service across ECOMP.
16517 example: __SERVICE-TYPE__
16518 - name: service-instance-id
16520 description: Uniquely identifies this instance of a service
16523 example: __SERVICE-INSTANCE-ID__
16526 description: Allotted Resource id UUID assigned to this instance.
16532 description: Allotted Resource id UUID assigned to this instance.
16538 description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
16541 $ref: "#/definitions/tunnel-xconnect"
16545 summary: update an existing tunnel-xconnect
16547 Update an existing tunnel-xconnect
16549 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16550 The PUT operation will entirely replace an existing object.
16551 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16553 Other differences between PUT and PATCH are:
16555 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16556 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16557 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16558 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16567 description: Response codes found in [response codes](https://wiki.onap.org/).
16569 - name: global-customer-id
16571 description: Global customer id used across ECOMP to uniquely identify customer.
16574 example: __GLOBAL-CUSTOMER-ID__
16575 - name: service-type
16577 description: Value defined by orchestration to identify this service across ECOMP.
16580 example: __SERVICE-TYPE__
16581 - name: service-instance-id
16583 description: Uniquely identifies this instance of a service
16586 example: __SERVICE-INSTANCE-ID__
16589 description: Allotted Resource id UUID assigned to this instance.
16595 description: Allotted Resource id UUID assigned to this instance.
16601 description: tunnel-xconnect object that needs to be created or updated.
16604 $ref: "#/patchDefinitions/tunnel-xconnect"
16608 summary: delete an existing tunnel-xconnect
16609 description: delete an existing tunnel-xconnect
16610 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16619 description: Response codes found in [response codes](https://wiki.onap.org/).
16621 - name: global-customer-id
16623 description: Global customer id used across ECOMP to uniquely identify customer.
16626 example: __GLOBAL-CUSTOMER-ID__
16627 - name: service-type
16629 description: Value defined by orchestration to identify this service across ECOMP.
16632 example: __SERVICE-TYPE__
16633 - name: service-instance-id
16635 description: Uniquely identifies this instance of a service
16638 example: __SERVICE-INSTANCE-ID__
16641 description: Allotted Resource id UUID assigned to this instance.
16647 description: Allotted Resource id UUID assigned to this instance.
16651 - name: resource-version
16653 description: resource-version for concurrency
16656 /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:
16660 summary: returns tunnel-xconnects
16661 description: returns tunnel-xconnects
16662 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
16668 description: successful operation
16670 $ref: "#/getDefinitions/tunnel-xconnects"
16672 description: Response codes found in [response codes](https://wiki.onap.org/).
16674 - name: global-customer-id
16676 description: Global customer id used across ECOMP to uniquely identify customer.
16679 example: __GLOBAL-CUSTOMER-ID__
16680 - name: service-type
16682 description: Value defined by orchestration to identify this service across ECOMP.
16685 example: __SERVICE-TYPE__
16686 - name: service-instance-id
16688 description: Uniquely identifies this instance of a service
16691 example: __SERVICE-INSTANCE-ID__
16694 description: Allotted Resource id UUID assigned to this instance.
16698 - name: subscriber-name
16700 description: Subscriber name, an alternate way to retrieve a customer.
16703 - name: subscriber-type
16705 description: Subscriber type, a way to provide VID with only the INFRA customers.
16708 - name: service-instance-name
16710 description: This field will store a name assigned to the service-instance.
16713 - name: environment-context
16715 description: This field will store the environment context assigned to the service-instance.
16718 - name: workload-context
16720 description: This field will store the workload context assigned to the service-instance.
16723 - name: model-invariant-id
16725 description: the ASDC model id for this resource or service model.
16728 - name: model-version-id
16730 description: the ASDC model version for this resource or service model.
16733 - name: widget-model-id
16735 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16738 - name: widget-model-version
16740 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16743 - name: service-instance-location-id
16745 description: An identifier that customers assign to the location where this service is being used.
16748 - name: orchestration-status
16750 description: Orchestration status of this service.
16753 - name: model-invariant-id
16755 description: the ASDC model id for this resource or service model.
16758 - name: model-version-id
16760 description: the ASDC model version for this resource or service model.
16765 description: Generic description of the type of allotted resource.
16770 description: role in the network that this resource will be providing.
16773 /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:
16777 summary: see node definition for valid relationships
16778 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
16787 description: Response codes found in [response codes](https://wiki.onap.org/).
16789 - name: global-customer-id
16791 description: Global customer id used across ECOMP to uniquely identify customer.
16794 example: __GLOBAL-CUSTOMER-ID__
16795 - name: service-type
16797 description: Value defined by orchestration to identify this service across ECOMP.
16800 example: __SERVICE-TYPE__
16801 - name: service-instance-id
16803 description: Uniquely identifies this instance of a service
16806 example: __SERVICE-INSTANCE-ID__
16809 description: Allotted Resource id UUID assigned to this instance.
16815 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
16818 $ref: "#/definitions/relationship"
16822 summary: delete an existing relationship
16823 description: delete an existing relationship
16824 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
16833 description: Response codes found in [response codes](https://wiki.onap.org/).
16835 - name: global-customer-id
16837 description: Global customer id used across ECOMP to uniquely identify customer.
16840 example: __GLOBAL-CUSTOMER-ID__
16841 - name: service-type
16843 description: Value defined by orchestration to identify this service across ECOMP.
16846 example: __SERVICE-TYPE__
16847 - name: service-instance-id
16849 description: Uniquely identifies this instance of a service
16852 example: __SERVICE-INSTANCE-ID__
16855 description: Allotted Resource id UUID assigned to this instance.
16859 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
16863 summary: returns allotted-resource
16864 description: returns allotted-resource
16865 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16871 description: successful operation
16873 $ref: "#/getDefinitions/allotted-resource"
16875 description: Response codes found in [response codes](https://wiki.onap.org/).
16877 - name: global-customer-id
16879 description: Global customer id used across ECOMP to uniquely identify customer.
16882 example: __GLOBAL-CUSTOMER-ID__
16883 - name: service-type
16885 description: Value defined by orchestration to identify this service across ECOMP.
16888 example: __SERVICE-TYPE__
16889 - name: service-instance-id
16891 description: Uniquely identifies this instance of a service
16894 example: __SERVICE-INSTANCE-ID__
16897 description: Allotted Resource id UUID assigned to this instance.
16901 - name: subscriber-name
16903 description: Subscriber name, an alternate way to retrieve a customer.
16906 - name: subscriber-type
16908 description: Subscriber type, a way to provide VID with only the INFRA customers.
16911 - name: service-instance-name
16913 description: This field will store a name assigned to the service-instance.
16916 - name: environment-context
16918 description: This field will store the environment context assigned to the service-instance.
16921 - name: workload-context
16923 description: This field will store the workload context assigned to the service-instance.
16926 - name: model-invariant-id
16928 description: the ASDC model id for this resource or service model.
16931 - name: model-version-id
16933 description: the ASDC model version for this resource or service model.
16936 - name: widget-model-id
16938 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16941 - name: widget-model-version
16943 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16946 - name: service-instance-location-id
16948 description: An identifier that customers assign to the location where this service is being used.
16951 - name: orchestration-status
16953 description: Orchestration status of this service.
16956 - name: model-invariant-id
16958 description: the ASDC model id for this resource or service model.
16961 - name: model-version-id
16963 description: the ASDC model version for this resource or service model.
16968 description: Generic description of the type of allotted resource.
16973 description: role in the network that this resource will be providing.
16979 summary: create or update an existing allotted-resource
16981 Create or update an existing allotted-resource.
16983 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16984 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16993 description: Response codes found in [response codes](https://wiki.onap.org/).
16995 - name: global-customer-id
16997 description: Global customer id used across ECOMP to uniquely identify customer.
17000 example: __GLOBAL-CUSTOMER-ID__
17001 - name: service-type
17003 description: Value defined by orchestration to identify this service across ECOMP.
17006 example: __SERVICE-TYPE__
17007 - name: service-instance-id
17009 description: Uniquely identifies this instance of a service
17012 example: __SERVICE-INSTANCE-ID__
17015 description: Allotted Resource id UUID assigned to this instance.
17021 description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
17024 $ref: "#/definitions/allotted-resource"
17028 summary: update an existing allotted-resource
17030 Update an existing allotted-resource
17032 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17033 The PUT operation will entirely replace an existing object.
17034 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17036 Other differences between PUT and PATCH are:
17038 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17039 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17040 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17041 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
17050 description: Response codes found in [response codes](https://wiki.onap.org/).
17052 - name: global-customer-id
17054 description: Global customer id used across ECOMP to uniquely identify customer.
17057 example: __GLOBAL-CUSTOMER-ID__
17058 - name: service-type
17060 description: Value defined by orchestration to identify this service across ECOMP.
17063 example: __SERVICE-TYPE__
17064 - name: service-instance-id
17066 description: Uniquely identifies this instance of a service
17069 example: __SERVICE-INSTANCE-ID__
17072 description: Allotted Resource id UUID assigned to this instance.
17078 description: allotted-resource object that needs to be created or updated.
17081 $ref: "#/patchDefinitions/allotted-resource"
17085 summary: delete an existing allotted-resource
17086 description: delete an existing allotted-resource
17087 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
17096 description: Response codes found in [response codes](https://wiki.onap.org/).
17098 - name: global-customer-id
17100 description: Global customer id used across ECOMP to uniquely identify customer.
17103 example: __GLOBAL-CUSTOMER-ID__
17104 - name: service-type
17106 description: Value defined by orchestration to identify this service across ECOMP.
17109 example: __SERVICE-TYPE__
17110 - name: service-instance-id
17112 description: Uniquely identifies this instance of a service
17115 example: __SERVICE-INSTANCE-ID__
17118 description: Allotted Resource id UUID assigned to this instance.
17122 - name: resource-version
17124 description: resource-version for concurrency
17127 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
17131 summary: returns allotted-resources
17132 description: returns allotted-resources
17133 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
17139 description: successful operation
17141 $ref: "#/getDefinitions/allotted-resources"
17143 description: Response codes found in [response codes](https://wiki.onap.org/).
17145 - name: global-customer-id
17147 description: Global customer id used across ECOMP to uniquely identify customer.
17150 example: __GLOBAL-CUSTOMER-ID__
17151 - name: service-type
17153 description: Value defined by orchestration to identify this service across ECOMP.
17156 example: __SERVICE-TYPE__
17157 - name: service-instance-id
17159 description: Uniquely identifies this instance of a service
17162 example: __SERVICE-INSTANCE-ID__
17163 - name: subscriber-name
17165 description: Subscriber name, an alternate way to retrieve a customer.
17168 - name: subscriber-type
17170 description: Subscriber type, a way to provide VID with only the INFRA customers.
17173 - name: service-instance-name
17175 description: This field will store a name assigned to the service-instance.
17178 - name: environment-context
17180 description: This field will store the environment context assigned to the service-instance.
17183 - name: workload-context
17185 description: This field will store the workload context assigned to the service-instance.
17188 - name: model-invariant-id
17190 description: the ASDC model id for this resource or service model.
17193 - name: model-version-id
17195 description: the ASDC model version for this resource or service model.
17198 - name: widget-model-id
17200 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17203 - name: widget-model-version
17205 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17208 - name: service-instance-location-id
17210 description: An identifier that customers assign to the location where this service is being used.
17213 - name: orchestration-status
17215 description: Orchestration status of this service.
17218 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
17222 summary: returns service-instance
17223 description: returns service-instance
17224 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17230 description: successful operation
17232 $ref: "#/getDefinitions/service-instance"
17234 description: Response codes found in [response codes](https://wiki.onap.org/).
17236 - name: global-customer-id
17238 description: Global customer id used across ECOMP to uniquely identify customer.
17241 example: __GLOBAL-CUSTOMER-ID__
17242 - name: service-type
17244 description: Value defined by orchestration to identify this service across ECOMP.
17247 example: __SERVICE-TYPE__
17248 - name: service-instance-id
17250 description: Uniquely identifies this instance of a service
17253 example: __SERVICE-INSTANCE-ID__
17254 - name: subscriber-name
17256 description: Subscriber name, an alternate way to retrieve a customer.
17259 - name: subscriber-type
17261 description: Subscriber type, a way to provide VID with only the INFRA customers.
17264 - name: service-instance-name
17266 description: This field will store a name assigned to the service-instance.
17269 - name: environment-context
17271 description: This field will store the environment context assigned to the service-instance.
17274 - name: workload-context
17276 description: This field will store the workload context assigned to the service-instance.
17279 - name: model-invariant-id
17281 description: the ASDC model id for this resource or service model.
17284 - name: model-version-id
17286 description: the ASDC model version for this resource or service model.
17289 - name: widget-model-id
17291 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17294 - name: widget-model-version
17296 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17299 - name: service-instance-location-id
17301 description: An identifier that customers assign to the location where this service is being used.
17304 - name: orchestration-status
17306 description: Orchestration status of this service.
17312 summary: create or update an existing service-instance
17314 Create or update an existing service-instance.
17316 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17317 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17326 description: Response codes found in [response codes](https://wiki.onap.org/).
17328 - name: global-customer-id
17330 description: Global customer id used across ECOMP to uniquely identify customer.
17333 example: __GLOBAL-CUSTOMER-ID__
17334 - name: service-type
17336 description: Value defined by orchestration to identify this service across ECOMP.
17339 example: __SERVICE-TYPE__
17340 - name: service-instance-id
17342 description: Uniquely identifies this instance of a service
17345 example: __SERVICE-INSTANCE-ID__
17348 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
17351 $ref: "#/definitions/service-instance"
17355 summary: update an existing service-instance
17357 Update an existing service-instance
17359 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17360 The PUT operation will entirely replace an existing object.
17361 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17363 Other differences between PUT and PATCH are:
17365 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17366 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17367 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17368 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17377 description: Response codes found in [response codes](https://wiki.onap.org/).
17379 - name: global-customer-id
17381 description: Global customer id used across ECOMP to uniquely identify customer.
17384 example: __GLOBAL-CUSTOMER-ID__
17385 - name: service-type
17387 description: Value defined by orchestration to identify this service across ECOMP.
17390 example: __SERVICE-TYPE__
17391 - name: service-instance-id
17393 description: Uniquely identifies this instance of a service
17396 example: __SERVICE-INSTANCE-ID__
17399 description: service-instance object that needs to be created or updated.
17402 $ref: "#/patchDefinitions/service-instance"
17406 summary: delete an existing service-instance
17407 description: delete an existing service-instance
17408 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17417 description: Response codes found in [response codes](https://wiki.onap.org/).
17419 - name: global-customer-id
17421 description: Global customer id used across ECOMP to uniquely identify customer.
17424 example: __GLOBAL-CUSTOMER-ID__
17425 - name: service-type
17427 description: Value defined by orchestration to identify this service across ECOMP.
17430 example: __SERVICE-TYPE__
17431 - name: service-instance-id
17433 description: Uniquely identifies this instance of a service
17436 example: __SERVICE-INSTANCE-ID__
17437 - name: resource-version
17439 description: resource-version for concurrency
17442 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
17446 summary: returns service-instances
17447 description: returns service-instances
17448 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
17454 description: successful operation
17456 $ref: "#/getDefinitions/service-instances"
17458 description: Response codes found in [response codes](https://wiki.onap.org/).
17460 - name: global-customer-id
17462 description: Global customer id used across ECOMP to uniquely identify customer.
17465 example: __GLOBAL-CUSTOMER-ID__
17466 - name: service-type
17468 description: Value defined by orchestration to identify this service across ECOMP.
17471 example: __SERVICE-TYPE__
17472 - name: subscriber-name
17474 description: Subscriber name, an alternate way to retrieve a customer.
17477 - name: subscriber-type
17479 description: Subscriber type, a way to provide VID with only the INFRA customers.
17482 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
17486 summary: see node definition for valid relationships
17487 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
17496 description: Response codes found in [response codes](https://wiki.onap.org/).
17498 - name: global-customer-id
17500 description: Global customer id used across ECOMP to uniquely identify customer.
17503 example: __GLOBAL-CUSTOMER-ID__
17504 - name: service-type
17506 description: Value defined by orchestration to identify this service across ECOMP.
17509 example: __SERVICE-TYPE__
17512 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
17515 $ref: "#/definitions/relationship"
17519 summary: delete an existing relationship
17520 description: delete an existing relationship
17521 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
17530 description: Response codes found in [response codes](https://wiki.onap.org/).
17532 - name: global-customer-id
17534 description: Global customer id used across ECOMP to uniquely identify customer.
17537 example: __GLOBAL-CUSTOMER-ID__
17538 - name: service-type
17540 description: Value defined by orchestration to identify this service across ECOMP.
17543 example: __SERVICE-TYPE__
17544 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
17548 summary: returns service-subscription
17549 description: returns service-subscription
17550 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17556 description: successful operation
17558 $ref: "#/getDefinitions/service-subscription"
17560 description: Response codes found in [response codes](https://wiki.onap.org/).
17562 - name: global-customer-id
17564 description: Global customer id used across ECOMP to uniquely identify customer.
17567 example: __GLOBAL-CUSTOMER-ID__
17568 - name: service-type
17570 description: Value defined by orchestration to identify this service across ECOMP.
17573 example: __SERVICE-TYPE__
17574 - name: subscriber-name
17576 description: Subscriber name, an alternate way to retrieve a customer.
17579 - name: subscriber-type
17581 description: Subscriber type, a way to provide VID with only the INFRA customers.
17587 summary: create or update an existing service-subscription
17589 Create or update an existing service-subscription.
17591 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17592 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17601 description: Response codes found in [response codes](https://wiki.onap.org/).
17603 - name: global-customer-id
17605 description: Global customer id used across ECOMP to uniquely identify customer.
17608 example: __GLOBAL-CUSTOMER-ID__
17609 - name: service-type
17611 description: Value defined by orchestration to identify this service across ECOMP.
17614 example: __SERVICE-TYPE__
17617 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
17620 $ref: "#/definitions/service-subscription"
17624 summary: update an existing service-subscription
17626 Update an existing service-subscription
17628 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17629 The PUT operation will entirely replace an existing object.
17630 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17632 Other differences between PUT and PATCH are:
17634 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17635 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17636 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17637 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17646 description: Response codes found in [response codes](https://wiki.onap.org/).
17648 - name: global-customer-id
17650 description: Global customer id used across ECOMP to uniquely identify customer.
17653 example: __GLOBAL-CUSTOMER-ID__
17654 - name: service-type
17656 description: Value defined by orchestration to identify this service across ECOMP.
17659 example: __SERVICE-TYPE__
17662 description: service-subscription object that needs to be created or updated.
17665 $ref: "#/patchDefinitions/service-subscription"
17669 summary: delete an existing service-subscription
17670 description: delete an existing service-subscription
17671 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17680 description: Response codes found in [response codes](https://wiki.onap.org/).
17682 - name: global-customer-id
17684 description: Global customer id used across ECOMP to uniquely identify customer.
17687 example: __GLOBAL-CUSTOMER-ID__
17688 - name: service-type
17690 description: Value defined by orchestration to identify this service across ECOMP.
17693 example: __SERVICE-TYPE__
17694 - name: resource-version
17696 description: resource-version for concurrency
17699 /business/customers/customer/{global-customer-id}/service-subscriptions:
17703 summary: returns service-subscriptions
17704 description: returns service-subscriptions
17705 operationId: getBusinessCustomersCustomerServiceSubscriptions
17711 description: successful operation
17713 $ref: "#/getDefinitions/service-subscriptions"
17715 description: Response codes found in [response codes](https://wiki.onap.org/).
17717 - name: global-customer-id
17719 description: Global customer id used across ECOMP to uniquely identify customer.
17722 example: __GLOBAL-CUSTOMER-ID__
17723 - name: subscriber-name
17725 description: Subscriber name, an alternate way to retrieve a customer.
17728 - name: subscriber-type
17730 description: Subscriber type, a way to provide VID with only the INFRA customers.
17733 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
17737 summary: see node definition for valid relationships
17738 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
17747 description: Response codes found in [response codes](https://wiki.onap.org/).
17749 - name: global-customer-id
17751 description: Global customer id used across ECOMP to uniquely identify customer.
17754 example: __GLOBAL-CUSTOMER-ID__
17757 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)
17760 $ref: "#/definitions/relationship"
17764 summary: delete an existing relationship
17765 description: delete an existing relationship
17766 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
17775 description: Response codes found in [response codes](https://wiki.onap.org/).
17777 - name: global-customer-id
17779 description: Global customer id used across ECOMP to uniquely identify customer.
17782 example: __GLOBAL-CUSTOMER-ID__
17783 /business/customers/customer/{global-customer-id}:
17787 summary: returns customer
17788 description: returns customer
17789 operationId: getBusinessCustomersCustomer
17795 description: successful operation
17797 $ref: "#/getDefinitions/customer"
17799 description: Response codes found in [response codes](https://wiki.onap.org/).
17801 - name: global-customer-id
17803 description: Global customer id used across ECOMP to uniquely identify customer.
17806 example: __GLOBAL-CUSTOMER-ID__
17807 - name: subscriber-name
17809 description: Subscriber name, an alternate way to retrieve a customer.
17812 - name: subscriber-type
17814 description: Subscriber type, a way to provide VID with only the INFRA customers.
17820 summary: create or update an existing customer
17822 Create or update an existing customer.
17824 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17825 operationId: createOrUpdateBusinessCustomersCustomer
17834 description: Response codes found in [response codes](https://wiki.onap.org/).
17836 - name: global-customer-id
17838 description: Global customer id used across ECOMP to uniquely identify customer.
17841 example: __GLOBAL-CUSTOMER-ID__
17844 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)
17847 $ref: "#/definitions/customer"
17851 summary: update an existing customer
17853 Update an existing customer
17855 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17856 The PUT operation will entirely replace an existing object.
17857 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17859 Other differences between PUT and PATCH are:
17861 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17862 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17863 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17864 operationId: UpdateBusinessCustomersCustomer
17873 description: Response codes found in [response codes](https://wiki.onap.org/).
17875 - name: global-customer-id
17877 description: Global customer id used across ECOMP to uniquely identify customer.
17880 example: __GLOBAL-CUSTOMER-ID__
17883 description: customer object that needs to be created or updated.
17886 $ref: "#/patchDefinitions/customer"
17890 summary: delete an existing customer
17891 description: delete an existing customer
17892 operationId: deleteBusinessCustomersCustomer
17901 description: Response codes found in [response codes](https://wiki.onap.org/).
17903 - name: global-customer-id
17905 description: Global customer id used across ECOMP to uniquely identify customer.
17908 example: __GLOBAL-CUSTOMER-ID__
17909 - name: resource-version
17911 description: resource-version for concurrency
17914 /business/customers:
17918 summary: returns customers
17919 description: returns customers
17920 operationId: getBusinessCustomers
17926 description: successful operation
17928 $ref: "#/getDefinitions/customers"
17930 description: Response codes found in [response codes](https://wiki.onap.org/).
17931 /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
17935 summary: see node definition for valid relationships
17936 operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
17945 description: Response codes found in [response codes](https://wiki.onap.org/).
17947 - name: line-of-business-name
17949 description: Name of the line-of-business (product)
17952 example: __LINE-OF-BUSINESS-NAME__
17955 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)
17958 $ref: "#/definitions/relationship"
17962 summary: delete an existing relationship
17963 description: delete an existing relationship
17964 operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
17973 description: Response codes found in [response codes](https://wiki.onap.org/).
17975 - name: line-of-business-name
17977 description: Name of the line-of-business (product)
17980 example: __LINE-OF-BUSINESS-NAME__
17981 /business/lines-of-business/line-of-business/{line-of-business-name}:
17985 summary: returns line-of-business
17986 description: returns line-of-business
17987 operationId: getBusinessLinesOfBusinessLineOfBusiness
17993 description: successful operation
17995 $ref: "#/getDefinitions/line-of-business"
17997 description: Response codes found in [response codes](https://wiki.onap.org/).
17999 - name: line-of-business-name
18001 description: Name of the line-of-business (product)
18004 example: __LINE-OF-BUSINESS-NAME__
18008 summary: create or update an existing line-of-business
18010 Create or update an existing line-of-business.
18012 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18013 operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
18022 description: Response codes found in [response codes](https://wiki.onap.org/).
18024 - name: line-of-business-name
18026 description: Name of the line-of-business (product)
18029 example: __LINE-OF-BUSINESS-NAME__
18032 description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)
18035 $ref: "#/definitions/line-of-business"
18039 summary: update an existing line-of-business
18041 Update an existing line-of-business
18043 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18044 The PUT operation will entirely replace an existing object.
18045 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18047 Other differences between PUT and PATCH are:
18049 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18050 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18051 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18052 operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
18061 description: Response codes found in [response codes](https://wiki.onap.org/).
18063 - name: line-of-business-name
18065 description: Name of the line-of-business (product)
18068 example: __LINE-OF-BUSINESS-NAME__
18071 description: line-of-business object that needs to be created or updated.
18074 $ref: "#/patchDefinitions/line-of-business"
18078 summary: delete an existing line-of-business
18079 description: delete an existing line-of-business
18080 operationId: deleteBusinessLinesOfBusinessLineOfBusiness
18089 description: Response codes found in [response codes](https://wiki.onap.org/).
18091 - name: line-of-business-name
18093 description: Name of the line-of-business (product)
18096 example: __LINE-OF-BUSINESS-NAME__
18097 - name: resource-version
18099 description: resource-version for concurrency
18102 /business/lines-of-business:
18106 summary: returns lines-of-business
18107 description: returns lines-of-business
18108 operationId: getBusinessLinesOfBusiness
18114 description: successful operation
18116 $ref: "#/getDefinitions/lines-of-business"
18118 description: Response codes found in [response codes](https://wiki.onap.org/).
18119 /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
18123 summary: see node definition for valid relationships
18124 operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
18133 description: Response codes found in [response codes](https://wiki.onap.org/).
18135 - name: owning-entity-id
18137 description: UUID of an owning entity
18140 example: __OWNING-ENTITY-ID__
18143 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)
18146 $ref: "#/definitions/relationship"
18150 summary: delete an existing relationship
18151 description: delete an existing relationship
18152 operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
18161 description: Response codes found in [response codes](https://wiki.onap.org/).
18163 - name: owning-entity-id
18165 description: UUID of an owning entity
18168 example: __OWNING-ENTITY-ID__
18169 /business/owning-entities/owning-entity/{owning-entity-id}:
18173 summary: returns owning-entity
18174 description: returns owning-entity
18175 operationId: getBusinessOwningEntitiesOwningEntity
18181 description: successful operation
18183 $ref: "#/getDefinitions/owning-entity"
18185 description: Response codes found in [response codes](https://wiki.onap.org/).
18187 - name: owning-entity-id
18189 description: UUID of an owning entity
18192 example: __OWNING-ENTITY-ID__
18196 summary: create or update an existing owning-entity
18198 Create or update an existing owning-entity.
18200 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18201 operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
18210 description: Response codes found in [response codes](https://wiki.onap.org/).
18212 - name: owning-entity-id
18214 description: UUID of an owning entity
18217 example: __OWNING-ENTITY-ID__
18220 description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)
18223 $ref: "#/definitions/owning-entity"
18227 summary: update an existing owning-entity
18229 Update an existing owning-entity
18231 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18232 The PUT operation will entirely replace an existing object.
18233 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18235 Other differences between PUT and PATCH are:
18237 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18238 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18239 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18240 operationId: UpdateBusinessOwningEntitiesOwningEntity
18249 description: Response codes found in [response codes](https://wiki.onap.org/).
18251 - name: owning-entity-id
18253 description: UUID of an owning entity
18256 example: __OWNING-ENTITY-ID__
18259 description: owning-entity object that needs to be created or updated.
18262 $ref: "#/patchDefinitions/owning-entity"
18266 summary: delete an existing owning-entity
18267 description: delete an existing owning-entity
18268 operationId: deleteBusinessOwningEntitiesOwningEntity
18277 description: Response codes found in [response codes](https://wiki.onap.org/).
18279 - name: owning-entity-id
18281 description: UUID of an owning entity
18284 example: __OWNING-ENTITY-ID__
18285 - name: resource-version
18287 description: resource-version for concurrency
18290 /business/owning-entities:
18294 summary: returns owning-entities
18295 description: returns owning-entities
18296 operationId: getBusinessOwningEntities
18302 description: successful operation
18304 $ref: "#/getDefinitions/owning-entities"
18306 description: Response codes found in [response codes](https://wiki.onap.org/).
18307 /business/platforms/platform/{platform-name}/relationship-list/relationship:
18311 summary: see node definition for valid relationships
18312 operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
18321 description: Response codes found in [response codes](https://wiki.onap.org/).
18323 - name: platform-name
18325 description: Name of the platform
18328 example: __PLATFORM-NAME__
18331 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)
18334 $ref: "#/definitions/relationship"
18338 summary: delete an existing relationship
18339 description: delete an existing relationship
18340 operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
18349 description: Response codes found in [response codes](https://wiki.onap.org/).
18351 - name: platform-name
18353 description: Name of the platform
18356 example: __PLATFORM-NAME__
18357 /business/platforms/platform/{platform-name}:
18361 summary: returns platform
18362 description: returns platform
18363 operationId: getBusinessPlatformsPlatform
18369 description: successful operation
18371 $ref: "#/getDefinitions/platform"
18373 description: Response codes found in [response codes](https://wiki.onap.org/).
18375 - name: platform-name
18377 description: Name of the platform
18380 example: __PLATFORM-NAME__
18384 summary: create or update an existing platform
18386 Create or update an existing platform.
18388 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18389 operationId: createOrUpdateBusinessPlatformsPlatform
18398 description: Response codes found in [response codes](https://wiki.onap.org/).
18400 - name: platform-name
18402 description: Name of the platform
18405 example: __PLATFORM-NAME__
18408 description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)
18411 $ref: "#/definitions/platform"
18415 summary: update an existing platform
18417 Update an existing platform
18419 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18420 The PUT operation will entirely replace an existing object.
18421 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18423 Other differences between PUT and PATCH are:
18425 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18426 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18427 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18428 operationId: UpdateBusinessPlatformsPlatform
18437 description: Response codes found in [response codes](https://wiki.onap.org/).
18439 - name: platform-name
18441 description: Name of the platform
18444 example: __PLATFORM-NAME__
18447 description: platform object that needs to be created or updated.
18450 $ref: "#/patchDefinitions/platform"
18454 summary: delete an existing platform
18455 description: delete an existing platform
18456 operationId: deleteBusinessPlatformsPlatform
18465 description: Response codes found in [response codes](https://wiki.onap.org/).
18467 - name: platform-name
18469 description: Name of the platform
18472 example: __PLATFORM-NAME__
18473 - name: resource-version
18475 description: resource-version for concurrency
18478 /business/platforms:
18482 summary: returns platforms
18483 description: returns platforms
18484 operationId: getBusinessPlatforms
18490 description: successful operation
18492 $ref: "#/getDefinitions/platforms"
18494 description: Response codes found in [response codes](https://wiki.onap.org/).
18495 /business/projects/project/{project-name}/relationship-list/relationship:
18499 summary: see node definition for valid relationships
18500 operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
18509 description: Response codes found in [response codes](https://wiki.onap.org/).
18511 - name: project-name
18513 description: Name of the project deploying a service
18516 example: __PROJECT-NAME__
18519 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)
18522 $ref: "#/definitions/relationship"
18526 summary: delete an existing relationship
18527 description: delete an existing relationship
18528 operationId: deleteBusinessProjectsProjectRelationshipListRelationship
18537 description: Response codes found in [response codes](https://wiki.onap.org/).
18539 - name: project-name
18541 description: Name of the project deploying a service
18544 example: __PROJECT-NAME__
18545 /business/projects/project/{project-name}:
18549 summary: returns project
18550 description: returns project
18551 operationId: getBusinessProjectsProject
18557 description: successful operation
18559 $ref: "#/getDefinitions/project"
18561 description: Response codes found in [response codes](https://wiki.onap.org/).
18563 - name: project-name
18565 description: Name of the project deploying a service
18568 example: __PROJECT-NAME__
18572 summary: create or update an existing project
18574 Create or update an existing project.
18576 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18577 operationId: createOrUpdateBusinessProjectsProject
18586 description: Response codes found in [response codes](https://wiki.onap.org/).
18588 - name: project-name
18590 description: Name of the project deploying a service
18593 example: __PROJECT-NAME__
18596 description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)
18599 $ref: "#/definitions/project"
18603 summary: update an existing project
18605 Update an existing project
18607 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18608 The PUT operation will entirely replace an existing object.
18609 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18611 Other differences between PUT and PATCH are:
18613 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18614 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18615 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18616 operationId: UpdateBusinessProjectsProject
18625 description: Response codes found in [response codes](https://wiki.onap.org/).
18627 - name: project-name
18629 description: Name of the project deploying a service
18632 example: __PROJECT-NAME__
18635 description: project object that needs to be created or updated.
18638 $ref: "#/patchDefinitions/project"
18642 summary: delete an existing project
18643 description: delete an existing project
18644 operationId: deleteBusinessProjectsProject
18653 description: Response codes found in [response codes](https://wiki.onap.org/).
18655 - name: project-name
18657 description: Name of the project deploying a service
18660 example: __PROJECT-NAME__
18661 - name: resource-version
18663 description: resource-version for concurrency
18666 /business/projects:
18670 summary: returns projects
18671 description: returns projects
18672 operationId: getBusinessProjects
18678 description: successful operation
18680 $ref: "#/getDefinitions/projects"
18682 description: Response codes found in [response codes](https://wiki.onap.org/).
18683 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
18686 - ServiceDesignAndCreation
18687 summary: see node definition for valid relationships
18688 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
18697 description: Response codes found in [response codes](https://wiki.onap.org/).
18699 - name: vnf-image-uuid
18701 description: Unique ID of this asset
18704 example: __VNF-IMAGE-UUID__
18707 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)
18710 $ref: "#/definitions/relationship"
18713 - ServiceDesignAndCreation
18714 summary: delete an existing relationship
18715 description: delete an existing relationship
18716 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
18725 description: Response codes found in [response codes](https://wiki.onap.org/).
18727 - name: vnf-image-uuid
18729 description: Unique ID of this asset
18732 example: __VNF-IMAGE-UUID__
18733 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
18736 - ServiceDesignAndCreation
18737 summary: returns vnf-image
18738 description: returns vnf-image
18739 operationId: getServiceDesignAndCreationVnfImagesVnfImage
18745 description: successful operation
18747 $ref: "#/getDefinitions/vnf-image"
18749 description: Response codes found in [response codes](https://wiki.onap.org/).
18751 - name: vnf-image-uuid
18753 description: Unique ID of this asset
18756 example: __VNF-IMAGE-UUID__
18757 - name: application
18759 description: The application that the image instantiates.
18762 - name: application-vendor
18764 description: The vendor of the application.
18767 - name: application-version
18769 description: The version of the application.
18774 - ServiceDesignAndCreation
18775 summary: create or update an existing vnf-image
18777 Create or update an existing vnf-image.
18779 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18780 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
18789 description: Response codes found in [response codes](https://wiki.onap.org/).
18791 - name: vnf-image-uuid
18793 description: Unique ID of this asset
18796 example: __VNF-IMAGE-UUID__
18799 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)
18802 $ref: "#/definitions/vnf-image"
18805 - ServiceDesignAndCreation
18806 summary: update an existing vnf-image
18808 Update an existing vnf-image
18810 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18811 The PUT operation will entirely replace an existing object.
18812 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18814 Other differences between PUT and PATCH are:
18816 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18817 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18818 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18819 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
18828 description: Response codes found in [response codes](https://wiki.onap.org/).
18830 - name: vnf-image-uuid
18832 description: Unique ID of this asset
18835 example: __VNF-IMAGE-UUID__
18838 description: vnf-image object that needs to be created or updated.
18841 $ref: "#/patchDefinitions/vnf-image"
18844 - ServiceDesignAndCreation
18845 summary: delete an existing vnf-image
18846 description: delete an existing vnf-image
18847 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
18856 description: Response codes found in [response codes](https://wiki.onap.org/).
18858 - name: vnf-image-uuid
18860 description: Unique ID of this asset
18863 example: __VNF-IMAGE-UUID__
18864 - name: resource-version
18866 description: resource-version for concurrency
18869 /service-design-and-creation/vnf-images:
18872 - ServiceDesignAndCreation
18873 summary: returns vnf-images
18874 description: returns vnf-images
18875 operationId: getServiceDesignAndCreationVnfImages
18881 description: successful operation
18883 $ref: "#/getDefinitions/vnf-images"
18885 description: Response codes found in [response codes](https://wiki.onap.org/).
18886 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
18889 - ServiceDesignAndCreation
18890 summary: see node definition for valid relationships
18891 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
18900 description: Response codes found in [response codes](https://wiki.onap.org/).
18904 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18907 example: __SERVICE-ID__
18910 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)
18913 $ref: "#/definitions/relationship"
18916 - ServiceDesignAndCreation
18917 summary: delete an existing relationship
18918 description: delete an existing relationship
18919 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
18928 description: Response codes found in [response codes](https://wiki.onap.org/).
18932 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18935 example: __SERVICE-ID__
18936 /service-design-and-creation/services/service/{service-id}:
18939 - ServiceDesignAndCreation
18940 summary: returns service
18941 description: returns service
18942 operationId: getServiceDesignAndCreationServicesService
18948 description: successful operation
18950 $ref: "#/getDefinitions/service"
18952 description: Response codes found in [response codes](https://wiki.onap.org/).
18956 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18959 example: __SERVICE-ID__
18960 - name: service-description
18962 description: Description of the service
18967 - ServiceDesignAndCreation
18968 summary: create or update an existing service
18970 Create or update an existing service.
18972 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18973 operationId: createOrUpdateServiceDesignAndCreationServicesService
18982 description: Response codes found in [response codes](https://wiki.onap.org/).
18986 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18989 example: __SERVICE-ID__
18992 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)
18995 $ref: "#/definitions/service"
18998 - ServiceDesignAndCreation
18999 summary: update an existing service
19001 Update an existing service
19003 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19004 The PUT operation will entirely replace an existing object.
19005 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19007 Other differences between PUT and PATCH are:
19009 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19010 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19011 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19012 operationId: UpdateServiceDesignAndCreationServicesService
19021 description: Response codes found in [response codes](https://wiki.onap.org/).
19025 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19028 example: __SERVICE-ID__
19031 description: service object that needs to be created or updated.
19034 $ref: "#/patchDefinitions/service"
19037 - ServiceDesignAndCreation
19038 summary: delete an existing service
19039 description: delete an existing service
19040 operationId: deleteServiceDesignAndCreationServicesService
19049 description: Response codes found in [response codes](https://wiki.onap.org/).
19053 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19056 example: __SERVICE-ID__
19057 - name: resource-version
19059 description: resource-version for concurrency
19062 /service-design-and-creation/services:
19065 - ServiceDesignAndCreation
19066 summary: returns services
19067 description: returns services
19068 operationId: getServiceDesignAndCreationServices
19074 description: successful operation
19076 $ref: "#/getDefinitions/services"
19078 description: Response codes found in [response codes](https://wiki.onap.org/).
19079 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
19082 - ServiceDesignAndCreation
19083 summary: see node definition for valid relationships
19084 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
19093 description: Response codes found in [response codes](https://wiki.onap.org/).
19095 - name: service-type
19097 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19100 example: __SERVICE-TYPE__
19103 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.
19106 example: __VNF-TYPE__
19109 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
19112 $ref: "#/definitions/relationship"
19115 - ServiceDesignAndCreation
19116 summary: delete an existing relationship
19117 description: delete an existing relationship
19118 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
19127 description: Response codes found in [response codes](https://wiki.onap.org/).
19129 - name: service-type
19131 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19134 example: __SERVICE-TYPE__
19137 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.
19140 example: __VNF-TYPE__
19141 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
19144 - ServiceDesignAndCreation
19145 summary: returns service-capability
19146 description: returns service-capability
19147 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
19153 description: successful operation
19155 $ref: "#/getDefinitions/service-capability"
19157 description: Response codes found in [response codes](https://wiki.onap.org/).
19159 - name: service-type
19161 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19164 example: __SERVICE-TYPE__
19167 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.
19170 example: __VNF-TYPE__
19173 - ServiceDesignAndCreation
19174 summary: create or update an existing service-capability
19176 Create or update an existing service-capability.
19178 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19179 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
19188 description: Response codes found in [response codes](https://wiki.onap.org/).
19190 - name: service-type
19192 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19195 example: __SERVICE-TYPE__
19198 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.
19201 example: __VNF-TYPE__
19204 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
19207 $ref: "#/definitions/service-capability"
19210 - ServiceDesignAndCreation
19211 summary: update an existing service-capability
19213 Update an existing service-capability
19215 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19216 The PUT operation will entirely replace an existing object.
19217 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19219 Other differences between PUT and PATCH are:
19221 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19222 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19223 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19224 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
19233 description: Response codes found in [response codes](https://wiki.onap.org/).
19235 - name: service-type
19237 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19240 example: __SERVICE-TYPE__
19243 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.
19246 example: __VNF-TYPE__
19249 description: service-capability object that needs to be created or updated.
19252 $ref: "#/patchDefinitions/service-capability"
19255 - ServiceDesignAndCreation
19256 summary: delete an existing service-capability
19257 description: delete an existing service-capability
19258 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
19267 description: Response codes found in [response codes](https://wiki.onap.org/).
19269 - name: service-type
19271 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19274 example: __SERVICE-TYPE__
19277 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.
19280 example: __VNF-TYPE__
19281 - name: resource-version
19283 description: resource-version for concurrency
19286 /service-design-and-creation/service-capabilities:
19289 - ServiceDesignAndCreation
19290 summary: returns service-capabilities
19291 description: returns service-capabilities
19292 operationId: getServiceDesignAndCreationServiceCapabilities
19298 description: successful operation
19300 $ref: "#/getDefinitions/service-capabilities"
19302 description: Response codes found in [response codes](https://wiki.onap.org/).
19303 /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:
19306 - ServiceDesignAndCreation
19307 summary: see node definition for valid relationships
19308 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
19317 description: Response codes found in [response codes](https://wiki.onap.org/).
19319 - name: model-invariant-id
19321 description: Unique identifier corresponding to the main definition of a model in ASDC
19324 example: __MODEL-INVARIANT-ID__
19325 - name: model-version-id
19327 description: Unique identifier corresponding to one version of a model in ASDC
19330 example: __MODEL-VERSION-ID__
19331 - name: model-element-uuid
19335 example: __MODEL-ELEMENT-UUID__
19336 - name: model-constraint-uuid
19340 example: __MODEL-CONSTRAINT-UUID__
19341 - name: constrained-element-set-uuid
19345 example: __CONSTRAINED-ELEMENT-SET-UUID__
19346 - name: element-choice-set-uuid
19350 example: __ELEMENT-CHOICE-SET-UUID__
19353 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
19356 $ref: "#/definitions/relationship"
19359 - ServiceDesignAndCreation
19360 summary: delete an existing relationship
19361 description: delete an existing relationship
19362 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
19371 description: Response codes found in [response codes](https://wiki.onap.org/).
19373 - name: model-invariant-id
19375 description: Unique identifier corresponding to the main definition of a model in ASDC
19378 example: __MODEL-INVARIANT-ID__
19379 - name: model-version-id
19381 description: Unique identifier corresponding to one version of a model in ASDC
19384 example: __MODEL-VERSION-ID__
19385 - name: model-element-uuid
19389 example: __MODEL-ELEMENT-UUID__
19390 - name: model-constraint-uuid
19394 example: __MODEL-CONSTRAINT-UUID__
19395 - name: constrained-element-set-uuid
19399 example: __CONSTRAINED-ELEMENT-SET-UUID__
19400 - name: element-choice-set-uuid
19404 example: __ELEMENT-CHOICE-SET-UUID__
19405 /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}:
19408 - ServiceDesignAndCreation
19409 summary: returns element-choice-set
19410 description: returns element-choice-set
19411 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19417 description: successful operation
19419 $ref: "#/getDefinitions/element-choice-set"
19421 description: Response codes found in [response codes](https://wiki.onap.org/).
19423 - name: model-invariant-id
19425 description: Unique identifier corresponding to the main definition of a model in ASDC
19428 example: __MODEL-INVARIANT-ID__
19429 - name: model-version-id
19431 description: Unique identifier corresponding to one version of a model in ASDC
19434 example: __MODEL-VERSION-ID__
19435 - name: model-element-uuid
19439 example: __MODEL-ELEMENT-UUID__
19440 - name: model-constraint-uuid
19444 example: __MODEL-CONSTRAINT-UUID__
19445 - name: constrained-element-set-uuid
19449 example: __CONSTRAINED-ELEMENT-SET-UUID__
19450 - name: element-choice-set-uuid
19454 example: __ELEMENT-CHOICE-SET-UUID__
19457 description: Type of the model, e.g., service, resource, widget, etc.
19462 description: Name of the model, which can change from version to version.
19465 - name: model-version
19467 description: Version
19472 - ServiceDesignAndCreation
19473 summary: create or update an existing element-choice-set
19475 Create or update an existing element-choice-set.
19477 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19478 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19487 description: Response codes found in [response codes](https://wiki.onap.org/).
19489 - name: model-invariant-id
19491 description: Unique identifier corresponding to the main definition of a model in ASDC
19494 example: __MODEL-INVARIANT-ID__
19495 - name: model-version-id
19497 description: Unique identifier corresponding to one version of a model in ASDC
19500 example: __MODEL-VERSION-ID__
19501 - name: model-element-uuid
19505 example: __MODEL-ELEMENT-UUID__
19506 - name: model-constraint-uuid
19510 example: __MODEL-CONSTRAINT-UUID__
19511 - name: constrained-element-set-uuid
19515 example: __CONSTRAINED-ELEMENT-SET-UUID__
19516 - name: element-choice-set-uuid
19520 example: __ELEMENT-CHOICE-SET-UUID__
19523 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
19526 $ref: "#/definitions/element-choice-set"
19529 - ServiceDesignAndCreation
19530 summary: update an existing element-choice-set
19532 Update an existing element-choice-set
19534 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19535 The PUT operation will entirely replace an existing object.
19536 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19538 Other differences between PUT and PATCH are:
19540 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19541 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19542 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19543 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19552 description: Response codes found in [response codes](https://wiki.onap.org/).
19554 - name: model-invariant-id
19556 description: Unique identifier corresponding to the main definition of a model in ASDC
19559 example: __MODEL-INVARIANT-ID__
19560 - name: model-version-id
19562 description: Unique identifier corresponding to one version of a model in ASDC
19565 example: __MODEL-VERSION-ID__
19566 - name: model-element-uuid
19570 example: __MODEL-ELEMENT-UUID__
19571 - name: model-constraint-uuid
19575 example: __MODEL-CONSTRAINT-UUID__
19576 - name: constrained-element-set-uuid
19580 example: __CONSTRAINED-ELEMENT-SET-UUID__
19581 - name: element-choice-set-uuid
19585 example: __ELEMENT-CHOICE-SET-UUID__
19588 description: element-choice-set object that needs to be created or updated.
19591 $ref: "#/patchDefinitions/element-choice-set"
19594 - ServiceDesignAndCreation
19595 summary: delete an existing element-choice-set
19596 description: delete an existing element-choice-set
19597 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19606 description: Response codes found in [response codes](https://wiki.onap.org/).
19608 - name: model-invariant-id
19610 description: Unique identifier corresponding to the main definition of a model in ASDC
19613 example: __MODEL-INVARIANT-ID__
19614 - name: model-version-id
19616 description: Unique identifier corresponding to one version of a model in ASDC
19619 example: __MODEL-VERSION-ID__
19620 - name: model-element-uuid
19624 example: __MODEL-ELEMENT-UUID__
19625 - name: model-constraint-uuid
19629 example: __MODEL-CONSTRAINT-UUID__
19630 - name: constrained-element-set-uuid
19634 example: __CONSTRAINED-ELEMENT-SET-UUID__
19635 - name: element-choice-set-uuid
19639 example: __ELEMENT-CHOICE-SET-UUID__
19640 - name: resource-version
19642 description: resource-version for concurrency
19645 /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:
19648 - ServiceDesignAndCreation
19649 summary: returns element-choice-sets
19650 description: returns element-choice-sets
19651 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
19657 description: successful operation
19659 $ref: "#/getDefinitions/element-choice-sets"
19661 description: Response codes found in [response codes](https://wiki.onap.org/).
19663 - name: model-invariant-id
19665 description: Unique identifier corresponding to the main definition of a model in ASDC
19668 example: __MODEL-INVARIANT-ID__
19669 - name: model-version-id
19671 description: Unique identifier corresponding to one version of a model in ASDC
19674 example: __MODEL-VERSION-ID__
19675 - name: model-element-uuid
19679 example: __MODEL-ELEMENT-UUID__
19680 - name: model-constraint-uuid
19684 example: __MODEL-CONSTRAINT-UUID__
19685 - name: constrained-element-set-uuid
19689 example: __CONSTRAINED-ELEMENT-SET-UUID__
19692 description: Type of the model, e.g., service, resource, widget, etc.
19697 description: Name of the model, which can change from version to version.
19700 - name: model-version
19702 description: Version
19705 /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:
19708 - ServiceDesignAndCreation
19709 summary: see node definition for valid relationships
19710 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
19719 description: Response codes found in [response codes](https://wiki.onap.org/).
19721 - name: model-invariant-id
19723 description: Unique identifier corresponding to the main definition of a model in ASDC
19726 example: __MODEL-INVARIANT-ID__
19727 - name: model-version-id
19729 description: Unique identifier corresponding to one version of a model in ASDC
19732 example: __MODEL-VERSION-ID__
19733 - name: model-element-uuid
19737 example: __MODEL-ELEMENT-UUID__
19738 - name: model-constraint-uuid
19742 example: __MODEL-CONSTRAINT-UUID__
19743 - name: constrained-element-set-uuid
19747 example: __CONSTRAINED-ELEMENT-SET-UUID__
19750 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
19753 $ref: "#/definitions/relationship"
19756 - ServiceDesignAndCreation
19757 summary: delete an existing relationship
19758 description: delete an existing relationship
19759 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
19768 description: Response codes found in [response codes](https://wiki.onap.org/).
19770 - name: model-invariant-id
19772 description: Unique identifier corresponding to the main definition of a model in ASDC
19775 example: __MODEL-INVARIANT-ID__
19776 - name: model-version-id
19778 description: Unique identifier corresponding to one version of a model in ASDC
19781 example: __MODEL-VERSION-ID__
19782 - name: model-element-uuid
19786 example: __MODEL-ELEMENT-UUID__
19787 - name: model-constraint-uuid
19791 example: __MODEL-CONSTRAINT-UUID__
19792 - name: constrained-element-set-uuid
19796 example: __CONSTRAINED-ELEMENT-SET-UUID__
19797 /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}:
19800 - ServiceDesignAndCreation
19801 summary: returns constrained-element-set
19802 description: returns constrained-element-set
19803 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19809 description: successful operation
19811 $ref: "#/getDefinitions/constrained-element-set"
19813 description: Response codes found in [response codes](https://wiki.onap.org/).
19815 - name: model-invariant-id
19817 description: Unique identifier corresponding to the main definition of a model in ASDC
19820 example: __MODEL-INVARIANT-ID__
19821 - name: model-version-id
19823 description: Unique identifier corresponding to one version of a model in ASDC
19826 example: __MODEL-VERSION-ID__
19827 - name: model-element-uuid
19831 example: __MODEL-ELEMENT-UUID__
19832 - name: model-constraint-uuid
19836 example: __MODEL-CONSTRAINT-UUID__
19837 - name: constrained-element-set-uuid
19841 example: __CONSTRAINED-ELEMENT-SET-UUID__
19844 description: Type of the model, e.g., service, resource, widget, etc.
19849 description: Name of the model, which can change from version to version.
19852 - name: model-version
19854 description: Version
19859 - ServiceDesignAndCreation
19860 summary: create or update an existing constrained-element-set
19862 Create or update an existing constrained-element-set.
19864 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19865 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19874 description: Response codes found in [response codes](https://wiki.onap.org/).
19876 - name: model-invariant-id
19878 description: Unique identifier corresponding to the main definition of a model in ASDC
19881 example: __MODEL-INVARIANT-ID__
19882 - name: model-version-id
19884 description: Unique identifier corresponding to one version of a model in ASDC
19887 example: __MODEL-VERSION-ID__
19888 - name: model-element-uuid
19892 example: __MODEL-ELEMENT-UUID__
19893 - name: model-constraint-uuid
19897 example: __MODEL-CONSTRAINT-UUID__
19898 - name: constrained-element-set-uuid
19902 example: __CONSTRAINED-ELEMENT-SET-UUID__
19905 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
19908 $ref: "#/definitions/constrained-element-set"
19911 - ServiceDesignAndCreation
19912 summary: update an existing constrained-element-set
19914 Update an existing constrained-element-set
19916 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19917 The PUT operation will entirely replace an existing object.
19918 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19920 Other differences between PUT and PATCH are:
19922 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19923 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19924 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19925 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19934 description: Response codes found in [response codes](https://wiki.onap.org/).
19936 - name: model-invariant-id
19938 description: Unique identifier corresponding to the main definition of a model in ASDC
19941 example: __MODEL-INVARIANT-ID__
19942 - name: model-version-id
19944 description: Unique identifier corresponding to one version of a model in ASDC
19947 example: __MODEL-VERSION-ID__
19948 - name: model-element-uuid
19952 example: __MODEL-ELEMENT-UUID__
19953 - name: model-constraint-uuid
19957 example: __MODEL-CONSTRAINT-UUID__
19958 - name: constrained-element-set-uuid
19962 example: __CONSTRAINED-ELEMENT-SET-UUID__
19965 description: constrained-element-set object that needs to be created or updated.
19968 $ref: "#/patchDefinitions/constrained-element-set"
19971 - ServiceDesignAndCreation
19972 summary: delete an existing constrained-element-set
19973 description: delete an existing constrained-element-set
19974 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19983 description: Response codes found in [response codes](https://wiki.onap.org/).
19985 - name: model-invariant-id
19987 description: Unique identifier corresponding to the main definition of a model in ASDC
19990 example: __MODEL-INVARIANT-ID__
19991 - name: model-version-id
19993 description: Unique identifier corresponding to one version of a model in ASDC
19996 example: __MODEL-VERSION-ID__
19997 - name: model-element-uuid
20001 example: __MODEL-ELEMENT-UUID__
20002 - name: model-constraint-uuid
20006 example: __MODEL-CONSTRAINT-UUID__
20007 - name: constrained-element-set-uuid
20011 example: __CONSTRAINED-ELEMENT-SET-UUID__
20012 - name: resource-version
20014 description: resource-version for concurrency
20017 /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:
20020 - ServiceDesignAndCreation
20021 summary: returns constrained-element-sets
20022 description: returns constrained-element-sets
20023 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
20029 description: successful operation
20031 $ref: "#/getDefinitions/constrained-element-sets"
20033 description: Response codes found in [response codes](https://wiki.onap.org/).
20035 - name: model-invariant-id
20037 description: Unique identifier corresponding to the main definition of a model in ASDC
20040 example: __MODEL-INVARIANT-ID__
20041 - name: model-version-id
20043 description: Unique identifier corresponding to one version of a model in ASDC
20046 example: __MODEL-VERSION-ID__
20047 - name: model-element-uuid
20051 example: __MODEL-ELEMENT-UUID__
20052 - name: model-constraint-uuid
20056 example: __MODEL-CONSTRAINT-UUID__
20059 description: Type of the model, e.g., service, resource, widget, etc.
20064 description: Name of the model, which can change from version to version.
20067 - name: model-version
20069 description: Version
20072 /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}:
20075 - ServiceDesignAndCreation
20076 summary: returns model-constraint
20077 description: returns model-constraint
20078 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20084 description: successful operation
20086 $ref: "#/getDefinitions/model-constraint"
20088 description: Response codes found in [response codes](https://wiki.onap.org/).
20090 - name: model-invariant-id
20092 description: Unique identifier corresponding to the main definition of a model in ASDC
20095 example: __MODEL-INVARIANT-ID__
20096 - name: model-version-id
20098 description: Unique identifier corresponding to one version of a model in ASDC
20101 example: __MODEL-VERSION-ID__
20102 - name: model-element-uuid
20106 example: __MODEL-ELEMENT-UUID__
20107 - name: model-constraint-uuid
20111 example: __MODEL-CONSTRAINT-UUID__
20114 description: Type of the model, e.g., service, resource, widget, etc.
20119 description: Name of the model, which can change from version to version.
20122 - name: model-version
20124 description: Version
20129 - ServiceDesignAndCreation
20130 summary: create or update an existing model-constraint
20132 Create or update an existing model-constraint.
20134 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20135 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20144 description: Response codes found in [response codes](https://wiki.onap.org/).
20146 - name: model-invariant-id
20148 description: Unique identifier corresponding to the main definition of a model in ASDC
20151 example: __MODEL-INVARIANT-ID__
20152 - name: model-version-id
20154 description: Unique identifier corresponding to one version of a model in ASDC
20157 example: __MODEL-VERSION-ID__
20158 - name: model-element-uuid
20162 example: __MODEL-ELEMENT-UUID__
20163 - name: model-constraint-uuid
20167 example: __MODEL-CONSTRAINT-UUID__
20170 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
20173 $ref: "#/definitions/model-constraint"
20176 - ServiceDesignAndCreation
20177 summary: update an existing model-constraint
20179 Update an existing model-constraint
20181 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20182 The PUT operation will entirely replace an existing object.
20183 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20185 Other differences between PUT and PATCH are:
20187 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20188 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20189 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20190 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20199 description: Response codes found in [response codes](https://wiki.onap.org/).
20201 - name: model-invariant-id
20203 description: Unique identifier corresponding to the main definition of a model in ASDC
20206 example: __MODEL-INVARIANT-ID__
20207 - name: model-version-id
20209 description: Unique identifier corresponding to one version of a model in ASDC
20212 example: __MODEL-VERSION-ID__
20213 - name: model-element-uuid
20217 example: __MODEL-ELEMENT-UUID__
20218 - name: model-constraint-uuid
20222 example: __MODEL-CONSTRAINT-UUID__
20225 description: model-constraint object that needs to be created or updated.
20228 $ref: "#/patchDefinitions/model-constraint"
20231 - ServiceDesignAndCreation
20232 summary: delete an existing model-constraint
20233 description: delete an existing model-constraint
20234 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20243 description: Response codes found in [response codes](https://wiki.onap.org/).
20245 - name: model-invariant-id
20247 description: Unique identifier corresponding to the main definition of a model in ASDC
20250 example: __MODEL-INVARIANT-ID__
20251 - name: model-version-id
20253 description: Unique identifier corresponding to one version of a model in ASDC
20256 example: __MODEL-VERSION-ID__
20257 - name: model-element-uuid
20261 example: __MODEL-ELEMENT-UUID__
20262 - name: model-constraint-uuid
20266 example: __MODEL-CONSTRAINT-UUID__
20267 - name: resource-version
20269 description: resource-version for concurrency
20272 /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:
20275 - ServiceDesignAndCreation
20276 summary: returns model-constraints
20277 description: returns model-constraints
20278 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
20284 description: successful operation
20286 $ref: "#/getDefinitions/model-constraints"
20288 description: Response codes found in [response codes](https://wiki.onap.org/).
20290 - name: model-invariant-id
20292 description: Unique identifier corresponding to the main definition of a model in ASDC
20295 example: __MODEL-INVARIANT-ID__
20296 - name: model-version-id
20298 description: Unique identifier corresponding to one version of a model in ASDC
20301 example: __MODEL-VERSION-ID__
20302 - name: model-element-uuid
20306 example: __MODEL-ELEMENT-UUID__
20309 description: Type of the model, e.g., service, resource, widget, etc.
20314 description: Name of the model, which can change from version to version.
20317 - name: model-version
20319 description: Version
20322 /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:
20325 - ServiceDesignAndCreation
20326 summary: see node definition for valid relationships
20327 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
20336 description: Response codes found in [response codes](https://wiki.onap.org/).
20338 - name: model-invariant-id
20340 description: Unique identifier corresponding to the main definition of a model in ASDC
20343 example: __MODEL-INVARIANT-ID__
20344 - name: model-version-id
20346 description: Unique identifier corresponding to one version of a model in ASDC
20349 example: __MODEL-VERSION-ID__
20350 - name: model-element-uuid
20354 example: __MODEL-ELEMENT-UUID__
20357 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
20360 $ref: "#/definitions/relationship"
20363 - ServiceDesignAndCreation
20364 summary: delete an existing relationship
20365 description: delete an existing relationship
20366 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
20375 description: Response codes found in [response codes](https://wiki.onap.org/).
20377 - name: model-invariant-id
20379 description: Unique identifier corresponding to the main definition of a model in ASDC
20382 example: __MODEL-INVARIANT-ID__
20383 - name: model-version-id
20385 description: Unique identifier corresponding to one version of a model in ASDC
20388 example: __MODEL-VERSION-ID__
20389 - name: model-element-uuid
20393 example: __MODEL-ELEMENT-UUID__
20394 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
20397 - ServiceDesignAndCreation
20398 summary: returns model-element
20399 description: returns model-element
20400 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20406 description: successful operation
20408 $ref: "#/getDefinitions/model-element"
20410 description: Response codes found in [response codes](https://wiki.onap.org/).
20412 - name: model-invariant-id
20414 description: Unique identifier corresponding to the main definition of a model in ASDC
20417 example: __MODEL-INVARIANT-ID__
20418 - name: model-version-id
20420 description: Unique identifier corresponding to one version of a model in ASDC
20423 example: __MODEL-VERSION-ID__
20424 - name: model-element-uuid
20428 example: __MODEL-ELEMENT-UUID__
20431 description: Type of the model, e.g., service, resource, widget, etc.
20436 description: Name of the model, which can change from version to version.
20439 - name: model-version
20441 description: Version
20446 - ServiceDesignAndCreation
20447 summary: create or update an existing model-element
20449 Create or update an existing model-element.
20451 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20452 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20461 description: Response codes found in [response codes](https://wiki.onap.org/).
20463 - name: model-invariant-id
20465 description: Unique identifier corresponding to the main definition of a model in ASDC
20468 example: __MODEL-INVARIANT-ID__
20469 - name: model-version-id
20471 description: Unique identifier corresponding to one version of a model in ASDC
20474 example: __MODEL-VERSION-ID__
20475 - name: model-element-uuid
20479 example: __MODEL-ELEMENT-UUID__
20482 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
20485 $ref: "#/definitions/model-element"
20488 - ServiceDesignAndCreation
20489 summary: update an existing model-element
20491 Update an existing model-element
20493 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20494 The PUT operation will entirely replace an existing object.
20495 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20497 Other differences between PUT and PATCH are:
20499 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20500 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20501 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20502 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20511 description: Response codes found in [response codes](https://wiki.onap.org/).
20513 - name: model-invariant-id
20515 description: Unique identifier corresponding to the main definition of a model in ASDC
20518 example: __MODEL-INVARIANT-ID__
20519 - name: model-version-id
20521 description: Unique identifier corresponding to one version of a model in ASDC
20524 example: __MODEL-VERSION-ID__
20525 - name: model-element-uuid
20529 example: __MODEL-ELEMENT-UUID__
20532 description: model-element object that needs to be created or updated.
20535 $ref: "#/patchDefinitions/model-element"
20538 - ServiceDesignAndCreation
20539 summary: delete an existing model-element
20540 description: delete an existing model-element
20541 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20550 description: Response codes found in [response codes](https://wiki.onap.org/).
20552 - name: model-invariant-id
20554 description: Unique identifier corresponding to the main definition of a model in ASDC
20557 example: __MODEL-INVARIANT-ID__
20558 - name: model-version-id
20560 description: Unique identifier corresponding to one version of a model in ASDC
20563 example: __MODEL-VERSION-ID__
20564 - name: model-element-uuid
20568 example: __MODEL-ELEMENT-UUID__
20569 - name: resource-version
20571 description: resource-version for concurrency
20574 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
20577 - ServiceDesignAndCreation
20578 summary: returns model-elements
20579 description: returns model-elements
20580 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
20586 description: successful operation
20588 $ref: "#/getDefinitions/model-elements"
20590 description: Response codes found in [response codes](https://wiki.onap.org/).
20592 - name: model-invariant-id
20594 description: Unique identifier corresponding to the main definition of a model in ASDC
20597 example: __MODEL-INVARIANT-ID__
20598 - name: model-version-id
20600 description: Unique identifier corresponding to one version of a model in ASDC
20603 example: __MODEL-VERSION-ID__
20606 description: Type of the model, e.g., service, resource, widget, etc.
20611 description: Name of the model, which can change from version to version.
20614 - name: model-version
20616 description: Version
20619 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
20622 - ServiceDesignAndCreation
20623 summary: returns metadatum
20624 description: returns metadatum
20625 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20631 description: successful operation
20633 $ref: "#/getDefinitions/metadatum"
20635 description: Response codes found in [response codes](https://wiki.onap.org/).
20637 - name: model-invariant-id
20639 description: Unique identifier corresponding to the main definition of a model in ASDC
20642 example: __MODEL-INVARIANT-ID__
20643 - name: model-version-id
20645 description: Unique identifier corresponding to one version of a model in ASDC
20648 example: __MODEL-VERSION-ID__
20653 example: __METANAME__
20656 description: Type of the model, e.g., service, resource, widget, etc.
20661 description: Name of the model, which can change from version to version.
20664 - name: model-version
20666 description: Version
20671 - ServiceDesignAndCreation
20672 summary: create or update an existing metadatum
20674 Create or update an existing metadatum.
20676 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20677 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20686 description: Response codes found in [response codes](https://wiki.onap.org/).
20688 - name: model-invariant-id
20690 description: Unique identifier corresponding to the main definition of a model in ASDC
20693 example: __MODEL-INVARIANT-ID__
20694 - name: model-version-id
20696 description: Unique identifier corresponding to one version of a model in ASDC
20699 example: __MODEL-VERSION-ID__
20704 example: __METANAME__
20707 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
20710 $ref: "#/definitions/metadatum"
20713 - ServiceDesignAndCreation
20714 summary: update an existing metadatum
20716 Update an existing metadatum
20718 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20719 The PUT operation will entirely replace an existing object.
20720 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20722 Other differences between PUT and PATCH are:
20724 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20725 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20726 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20727 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20736 description: Response codes found in [response codes](https://wiki.onap.org/).
20738 - name: model-invariant-id
20740 description: Unique identifier corresponding to the main definition of a model in ASDC
20743 example: __MODEL-INVARIANT-ID__
20744 - name: model-version-id
20746 description: Unique identifier corresponding to one version of a model in ASDC
20749 example: __MODEL-VERSION-ID__
20754 example: __METANAME__
20757 description: metadatum object that needs to be created or updated.
20760 $ref: "#/patchDefinitions/metadatum"
20763 - ServiceDesignAndCreation
20764 summary: delete an existing metadatum
20765 description: delete an existing metadatum
20766 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20775 description: Response codes found in [response codes](https://wiki.onap.org/).
20777 - name: model-invariant-id
20779 description: Unique identifier corresponding to the main definition of a model in ASDC
20782 example: __MODEL-INVARIANT-ID__
20783 - name: model-version-id
20785 description: Unique identifier corresponding to one version of a model in ASDC
20788 example: __MODEL-VERSION-ID__
20793 example: __METANAME__
20794 - name: resource-version
20796 description: resource-version for concurrency
20799 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
20802 - ServiceDesignAndCreation
20803 summary: returns metadata
20804 description: returns metadata
20805 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
20811 description: successful operation
20813 $ref: "#/getDefinitions/metadata"
20815 description: Response codes found in [response codes](https://wiki.onap.org/).
20817 - name: model-invariant-id
20819 description: Unique identifier corresponding to the main definition of a model in ASDC
20822 example: __MODEL-INVARIANT-ID__
20823 - name: model-version-id
20825 description: Unique identifier corresponding to one version of a model in ASDC
20828 example: __MODEL-VERSION-ID__
20831 description: Type of the model, e.g., service, resource, widget, etc.
20836 description: Name of the model, which can change from version to version.
20839 - name: model-version
20841 description: Version
20844 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
20847 - ServiceDesignAndCreation
20848 summary: see node definition for valid relationships
20849 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
20858 description: Response codes found in [response codes](https://wiki.onap.org/).
20860 - name: model-invariant-id
20862 description: Unique identifier corresponding to the main definition of a model in ASDC
20865 example: __MODEL-INVARIANT-ID__
20866 - name: model-version-id
20868 description: Unique identifier corresponding to one version of a model in ASDC
20871 example: __MODEL-VERSION-ID__
20874 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
20877 $ref: "#/definitions/relationship"
20880 - ServiceDesignAndCreation
20881 summary: delete an existing relationship
20882 description: delete an existing relationship
20883 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
20892 description: Response codes found in [response codes](https://wiki.onap.org/).
20894 - name: model-invariant-id
20896 description: Unique identifier corresponding to the main definition of a model in ASDC
20899 example: __MODEL-INVARIANT-ID__
20900 - name: model-version-id
20902 description: Unique identifier corresponding to one version of a model in ASDC
20905 example: __MODEL-VERSION-ID__
20906 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
20909 - ServiceDesignAndCreation
20910 summary: returns model-ver
20911 description: returns model-ver
20912 operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
20918 description: successful operation
20920 $ref: "#/getDefinitions/model-ver"
20922 description: Response codes found in [response codes](https://wiki.onap.org/).
20924 - name: model-invariant-id
20926 description: Unique identifier corresponding to the main definition of a model in ASDC
20929 example: __MODEL-INVARIANT-ID__
20930 - name: model-version-id
20932 description: Unique identifier corresponding to one version of a model in ASDC
20935 example: __MODEL-VERSION-ID__
20938 description: Type of the model, e.g., service, resource, widget, etc.
20943 description: Name of the model, which can change from version to version.
20946 - name: model-version
20948 description: Version
20953 - ServiceDesignAndCreation
20954 summary: create or update an existing model-ver
20956 Create or update an existing model-ver.
20958 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20959 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
20968 description: Response codes found in [response codes](https://wiki.onap.org/).
20970 - name: model-invariant-id
20972 description: Unique identifier corresponding to the main definition of a model in ASDC
20975 example: __MODEL-INVARIANT-ID__
20976 - name: model-version-id
20978 description: Unique identifier corresponding to one version of a model in ASDC
20981 example: __MODEL-VERSION-ID__
20984 description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
20987 $ref: "#/definitions/model-ver"
20990 - ServiceDesignAndCreation
20991 summary: update an existing model-ver
20993 Update an existing model-ver
20995 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20996 The PUT operation will entirely replace an existing object.
20997 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20999 Other differences between PUT and PATCH are:
21001 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21002 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21003 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21004 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
21013 description: Response codes found in [response codes](https://wiki.onap.org/).
21015 - name: model-invariant-id
21017 description: Unique identifier corresponding to the main definition of a model in ASDC
21020 example: __MODEL-INVARIANT-ID__
21021 - name: model-version-id
21023 description: Unique identifier corresponding to one version of a model in ASDC
21026 example: __MODEL-VERSION-ID__
21029 description: model-ver object that needs to be created or updated.
21032 $ref: "#/patchDefinitions/model-ver"
21035 - ServiceDesignAndCreation
21036 summary: delete an existing model-ver
21037 description: delete an existing model-ver
21038 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
21047 description: Response codes found in [response codes](https://wiki.onap.org/).
21049 - name: model-invariant-id
21051 description: Unique identifier corresponding to the main definition of a model in ASDC
21054 example: __MODEL-INVARIANT-ID__
21055 - name: model-version-id
21057 description: Unique identifier corresponding to one version of a model in ASDC
21060 example: __MODEL-VERSION-ID__
21061 - name: resource-version
21063 description: resource-version for concurrency
21066 /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
21069 - ServiceDesignAndCreation
21070 summary: returns model-vers
21071 description: returns model-vers
21072 operationId: getServiceDesignAndCreationModelsModelModelVers
21078 description: successful operation
21080 $ref: "#/getDefinitions/model-vers"
21082 description: Response codes found in [response codes](https://wiki.onap.org/).
21084 - name: model-invariant-id
21086 description: Unique identifier corresponding to the main definition of a model in ASDC
21089 example: __MODEL-INVARIANT-ID__
21092 description: Type of the model, e.g., service, resource, widget, etc.
21095 /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
21098 - ServiceDesignAndCreation
21099 summary: see node definition for valid relationships
21100 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
21109 description: Response codes found in [response codes](https://wiki.onap.org/).
21111 - name: model-invariant-id
21113 description: Unique identifier corresponding to the main definition of a model in ASDC
21116 example: __MODEL-INVARIANT-ID__
21119 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)
21122 $ref: "#/definitions/relationship"
21125 - ServiceDesignAndCreation
21126 summary: delete an existing relationship
21127 description: delete an existing relationship
21128 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
21137 description: Response codes found in [response codes](https://wiki.onap.org/).
21139 - name: model-invariant-id
21141 description: Unique identifier corresponding to the main definition of a model in ASDC
21144 example: __MODEL-INVARIANT-ID__
21145 /service-design-and-creation/models/model/{model-invariant-id}:
21148 - ServiceDesignAndCreation
21149 summary: returns model
21150 description: returns model
21151 operationId: getServiceDesignAndCreationModelsModel
21157 description: successful operation
21159 $ref: "#/getDefinitions/model"
21161 description: Response codes found in [response codes](https://wiki.onap.org/).
21163 - name: model-invariant-id
21165 description: Unique identifier corresponding to the main definition of a model in ASDC
21168 example: __MODEL-INVARIANT-ID__
21171 description: Type of the model, e.g., service, resource, widget, etc.
21176 - ServiceDesignAndCreation
21177 summary: create or update an existing model
21179 Create or update an existing model.
21181 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21182 operationId: createOrUpdateServiceDesignAndCreationModelsModel
21191 description: Response codes found in [response codes](https://wiki.onap.org/).
21193 - name: model-invariant-id
21195 description: Unique identifier corresponding to the main definition of a model in ASDC
21198 example: __MODEL-INVARIANT-ID__
21201 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)
21204 $ref: "#/definitions/model"
21207 - ServiceDesignAndCreation
21208 summary: update an existing model
21210 Update an existing model
21212 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21213 The PUT operation will entirely replace an existing object.
21214 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21216 Other differences between PUT and PATCH are:
21218 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21219 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21220 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21221 operationId: UpdateServiceDesignAndCreationModelsModel
21230 description: Response codes found in [response codes](https://wiki.onap.org/).
21232 - name: model-invariant-id
21234 description: Unique identifier corresponding to the main definition of a model in ASDC
21237 example: __MODEL-INVARIANT-ID__
21240 description: model object that needs to be created or updated.
21243 $ref: "#/patchDefinitions/model"
21246 - ServiceDesignAndCreation
21247 summary: delete an existing model
21248 description: delete an existing model
21249 operationId: deleteServiceDesignAndCreationModelsModel
21258 description: Response codes found in [response codes](https://wiki.onap.org/).
21260 - name: model-invariant-id
21262 description: Unique identifier corresponding to the main definition of a model in ASDC
21265 example: __MODEL-INVARIANT-ID__
21266 - name: resource-version
21268 description: resource-version for concurrency
21271 /service-design-and-creation/models:
21274 - ServiceDesignAndCreation
21275 summary: returns models
21276 description: returns models
21277 operationId: getServiceDesignAndCreationModels
21283 description: successful operation
21285 $ref: "#/getDefinitions/models"
21287 description: Response codes found in [response codes](https://wiki.onap.org/).
21288 /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:
21291 - ServiceDesignAndCreation
21292 summary: see node definition for valid relationships
21293 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
21302 description: Response codes found in [response codes](https://wiki.onap.org/).
21304 - name: named-query-uuid
21308 example: __NAMED-QUERY-UUID__
21309 - name: named-query-element-uuid
21313 example: __NAMED-QUERY-ELEMENT-UUID__
21314 - name: related-lookup-uuid
21318 example: __RELATED-LOOKUP-UUID__
21321 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
21324 $ref: "#/definitions/relationship"
21327 - ServiceDesignAndCreation
21328 summary: delete an existing relationship
21329 description: delete an existing relationship
21330 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
21339 description: Response codes found in [response codes](https://wiki.onap.org/).
21341 - name: named-query-uuid
21345 example: __NAMED-QUERY-UUID__
21346 - name: named-query-element-uuid
21350 example: __NAMED-QUERY-ELEMENT-UUID__
21351 - name: related-lookup-uuid
21355 example: __RELATED-LOOKUP-UUID__
21356 /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}:
21359 - ServiceDesignAndCreation
21360 summary: returns related-lookup
21361 description: returns related-lookup
21362 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21368 description: successful operation
21370 $ref: "#/getDefinitions/related-lookup"
21372 description: Response codes found in [response codes](https://wiki.onap.org/).
21374 - name: named-query-uuid
21378 example: __NAMED-QUERY-UUID__
21379 - name: named-query-element-uuid
21383 example: __NAMED-QUERY-ELEMENT-UUID__
21384 - name: related-lookup-uuid
21388 example: __RELATED-LOOKUP-UUID__
21389 - name: named-query-name
21395 - ServiceDesignAndCreation
21396 summary: create or update an existing related-lookup
21398 Create or update an existing related-lookup.
21400 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21401 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21410 description: Response codes found in [response codes](https://wiki.onap.org/).
21412 - name: named-query-uuid
21416 example: __NAMED-QUERY-UUID__
21417 - name: named-query-element-uuid
21421 example: __NAMED-QUERY-ELEMENT-UUID__
21422 - name: related-lookup-uuid
21426 example: __RELATED-LOOKUP-UUID__
21429 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
21432 $ref: "#/definitions/related-lookup"
21435 - ServiceDesignAndCreation
21436 summary: update an existing related-lookup
21438 Update an existing related-lookup
21440 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21441 The PUT operation will entirely replace an existing object.
21442 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21444 Other differences between PUT and PATCH are:
21446 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21447 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21448 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21449 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21458 description: Response codes found in [response codes](https://wiki.onap.org/).
21460 - name: named-query-uuid
21464 example: __NAMED-QUERY-UUID__
21465 - name: named-query-element-uuid
21469 example: __NAMED-QUERY-ELEMENT-UUID__
21470 - name: related-lookup-uuid
21474 example: __RELATED-LOOKUP-UUID__
21477 description: related-lookup object that needs to be created or updated.
21480 $ref: "#/patchDefinitions/related-lookup"
21483 - ServiceDesignAndCreation
21484 summary: delete an existing related-lookup
21485 description: delete an existing related-lookup
21486 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21495 description: Response codes found in [response codes](https://wiki.onap.org/).
21497 - name: named-query-uuid
21501 example: __NAMED-QUERY-UUID__
21502 - name: named-query-element-uuid
21506 example: __NAMED-QUERY-ELEMENT-UUID__
21507 - name: related-lookup-uuid
21511 example: __RELATED-LOOKUP-UUID__
21512 - name: resource-version
21514 description: resource-version for concurrency
21517 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
21520 - ServiceDesignAndCreation
21521 summary: returns related-lookups
21522 description: returns related-lookups
21523 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
21529 description: successful operation
21531 $ref: "#/getDefinitions/related-lookups"
21533 description: Response codes found in [response codes](https://wiki.onap.org/).
21535 - name: named-query-uuid
21539 example: __NAMED-QUERY-UUID__
21540 - name: named-query-element-uuid
21544 example: __NAMED-QUERY-ELEMENT-UUID__
21545 - name: named-query-name
21549 /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}:
21552 - ServiceDesignAndCreation
21553 summary: returns property-constraint
21554 description: returns property-constraint
21555 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21561 description: successful operation
21563 $ref: "#/getDefinitions/property-constraint"
21565 description: Response codes found in [response codes](https://wiki.onap.org/).
21567 - name: named-query-uuid
21571 example: __NAMED-QUERY-UUID__
21572 - name: named-query-element-uuid
21576 example: __NAMED-QUERY-ELEMENT-UUID__
21577 - name: property-constraint-uuid
21581 example: __PROPERTY-CONSTRAINT-UUID__
21582 - name: named-query-name
21588 - ServiceDesignAndCreation
21589 summary: create or update an existing property-constraint
21591 Create or update an existing property-constraint.
21593 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21594 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21603 description: Response codes found in [response codes](https://wiki.onap.org/).
21605 - name: named-query-uuid
21609 example: __NAMED-QUERY-UUID__
21610 - name: named-query-element-uuid
21614 example: __NAMED-QUERY-ELEMENT-UUID__
21615 - name: property-constraint-uuid
21619 example: __PROPERTY-CONSTRAINT-UUID__
21622 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
21625 $ref: "#/definitions/property-constraint"
21628 - ServiceDesignAndCreation
21629 summary: update an existing property-constraint
21631 Update an existing property-constraint
21633 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21634 The PUT operation will entirely replace an existing object.
21635 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21637 Other differences between PUT and PATCH are:
21639 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21640 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21641 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21642 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21651 description: Response codes found in [response codes](https://wiki.onap.org/).
21653 - name: named-query-uuid
21657 example: __NAMED-QUERY-UUID__
21658 - name: named-query-element-uuid
21662 example: __NAMED-QUERY-ELEMENT-UUID__
21663 - name: property-constraint-uuid
21667 example: __PROPERTY-CONSTRAINT-UUID__
21670 description: property-constraint object that needs to be created or updated.
21673 $ref: "#/patchDefinitions/property-constraint"
21676 - ServiceDesignAndCreation
21677 summary: delete an existing property-constraint
21678 description: delete an existing property-constraint
21679 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21688 description: Response codes found in [response codes](https://wiki.onap.org/).
21690 - name: named-query-uuid
21694 example: __NAMED-QUERY-UUID__
21695 - name: named-query-element-uuid
21699 example: __NAMED-QUERY-ELEMENT-UUID__
21700 - name: property-constraint-uuid
21704 example: __PROPERTY-CONSTRAINT-UUID__
21705 - name: resource-version
21707 description: resource-version for concurrency
21710 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
21713 - ServiceDesignAndCreation
21714 summary: returns property-constraints
21715 description: returns property-constraints
21716 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
21722 description: successful operation
21724 $ref: "#/getDefinitions/property-constraints"
21726 description: Response codes found in [response codes](https://wiki.onap.org/).
21728 - name: named-query-uuid
21732 example: __NAMED-QUERY-UUID__
21733 - name: named-query-element-uuid
21737 example: __NAMED-QUERY-ELEMENT-UUID__
21738 - name: named-query-name
21742 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
21745 - ServiceDesignAndCreation
21746 summary: see node definition for valid relationships
21747 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
21756 description: Response codes found in [response codes](https://wiki.onap.org/).
21758 - name: named-query-uuid
21762 example: __NAMED-QUERY-UUID__
21763 - name: named-query-element-uuid
21767 example: __NAMED-QUERY-ELEMENT-UUID__
21770 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
21773 $ref: "#/definitions/relationship"
21776 - ServiceDesignAndCreation
21777 summary: delete an existing relationship
21778 description: delete an existing relationship
21779 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
21788 description: Response codes found in [response codes](https://wiki.onap.org/).
21790 - name: named-query-uuid
21794 example: __NAMED-QUERY-UUID__
21795 - name: named-query-element-uuid
21799 example: __NAMED-QUERY-ELEMENT-UUID__
21800 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
21803 - ServiceDesignAndCreation
21804 summary: returns named-query-element
21805 description: returns named-query-element
21806 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21812 description: successful operation
21814 $ref: "#/getDefinitions/named-query-element"
21816 description: Response codes found in [response codes](https://wiki.onap.org/).
21818 - name: named-query-uuid
21822 example: __NAMED-QUERY-UUID__
21823 - name: named-query-element-uuid
21827 example: __NAMED-QUERY-ELEMENT-UUID__
21828 - name: named-query-name
21834 - ServiceDesignAndCreation
21835 summary: create or update an existing named-query-element
21837 Create or update an existing named-query-element.
21839 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21840 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21849 description: Response codes found in [response codes](https://wiki.onap.org/).
21851 - name: named-query-uuid
21855 example: __NAMED-QUERY-UUID__
21856 - name: named-query-element-uuid
21860 example: __NAMED-QUERY-ELEMENT-UUID__
21863 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
21866 $ref: "#/definitions/named-query-element"
21869 - ServiceDesignAndCreation
21870 summary: update an existing named-query-element
21872 Update an existing named-query-element
21874 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21875 The PUT operation will entirely replace an existing object.
21876 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21878 Other differences between PUT and PATCH are:
21880 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21881 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21882 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21883 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21892 description: Response codes found in [response codes](https://wiki.onap.org/).
21894 - name: named-query-uuid
21898 example: __NAMED-QUERY-UUID__
21899 - name: named-query-element-uuid
21903 example: __NAMED-QUERY-ELEMENT-UUID__
21906 description: named-query-element object that needs to be created or updated.
21909 $ref: "#/patchDefinitions/named-query-element"
21912 - ServiceDesignAndCreation
21913 summary: delete an existing named-query-element
21914 description: delete an existing named-query-element
21915 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21924 description: Response codes found in [response codes](https://wiki.onap.org/).
21926 - name: named-query-uuid
21930 example: __NAMED-QUERY-UUID__
21931 - name: named-query-element-uuid
21935 example: __NAMED-QUERY-ELEMENT-UUID__
21936 - name: resource-version
21938 description: resource-version for concurrency
21941 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
21944 - ServiceDesignAndCreation
21945 summary: returns named-query-elements
21946 description: returns named-query-elements
21947 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
21953 description: successful operation
21955 $ref: "#/getDefinitions/named-query-elements"
21957 description: Response codes found in [response codes](https://wiki.onap.org/).
21959 - name: named-query-uuid
21963 example: __NAMED-QUERY-UUID__
21964 - name: named-query-name
21968 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
21971 - ServiceDesignAndCreation
21972 summary: see node definition for valid relationships
21973 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
21982 description: Response codes found in [response codes](https://wiki.onap.org/).
21984 - name: named-query-uuid
21988 example: __NAMED-QUERY-UUID__
21991 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
21994 $ref: "#/definitions/relationship"
21997 - ServiceDesignAndCreation
21998 summary: delete an existing relationship
21999 description: delete an existing relationship
22000 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
22009 description: Response codes found in [response codes](https://wiki.onap.org/).
22011 - name: named-query-uuid
22015 example: __NAMED-QUERY-UUID__
22016 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
22019 - ServiceDesignAndCreation
22020 summary: returns named-query
22021 description: returns named-query
22022 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
22028 description: successful operation
22030 $ref: "#/getDefinitions/named-query"
22032 description: Response codes found in [response codes](https://wiki.onap.org/).
22034 - name: named-query-uuid
22038 example: __NAMED-QUERY-UUID__
22039 - name: named-query-name
22045 - ServiceDesignAndCreation
22046 summary: create or update an existing named-query
22048 Create or update an existing named-query.
22050 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22051 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
22060 description: Response codes found in [response codes](https://wiki.onap.org/).
22062 - name: named-query-uuid
22066 example: __NAMED-QUERY-UUID__
22069 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
22072 $ref: "#/definitions/named-query"
22075 - ServiceDesignAndCreation
22076 summary: update an existing named-query
22078 Update an existing named-query
22080 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22081 The PUT operation will entirely replace an existing object.
22082 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22084 Other differences between PUT and PATCH are:
22086 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22087 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22088 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22089 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
22098 description: Response codes found in [response codes](https://wiki.onap.org/).
22100 - name: named-query-uuid
22104 example: __NAMED-QUERY-UUID__
22107 description: named-query object that needs to be created or updated.
22110 $ref: "#/patchDefinitions/named-query"
22113 - ServiceDesignAndCreation
22114 summary: delete an existing named-query
22115 description: delete an existing named-query
22116 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
22125 description: Response codes found in [response codes](https://wiki.onap.org/).
22127 - name: named-query-uuid
22131 example: __NAMED-QUERY-UUID__
22132 - name: resource-version
22134 description: resource-version for concurrency
22137 /service-design-and-creation/named-queries:
22140 - ServiceDesignAndCreation
22141 summary: returns named-queries
22142 description: returns named-queries
22143 operationId: getServiceDesignAndCreationNamedQueries
22149 description: successful operation
22151 $ref: "#/getDefinitions/named-queries"
22153 description: Response codes found in [response codes](https://wiki.onap.org/).
22154 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
22158 summary: see node definition for valid relationships
22159 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
22168 description: Response codes found in [response codes](https://wiki.onap.org/).
22172 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22175 example: __LINK-NAME__
22178 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)
22181 $ref: "#/definitions/relationship"
22185 summary: delete an existing relationship
22186 description: delete an existing relationship
22187 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
22196 description: Response codes found in [response codes](https://wiki.onap.org/).
22200 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22203 example: __LINK-NAME__
22204 /network/logical-links/logical-link/{link-name}:
22208 summary: returns logical-link
22209 description: returns logical-link
22210 operationId: getNetworkLogicalLinksLogicalLink
22216 description: successful operation
22218 $ref: "#/getDefinitions/logical-link"
22220 description: Response codes found in [response codes](https://wiki.onap.org/).
22224 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22227 example: __LINK-NAME__
22228 - name: model-invariant-id
22230 description: the ASDC model id for this resource or service model.
22233 - name: model-version-id
22235 description: the ASDC model version for this resource or service model.
22238 - name: widget-model-id
22240 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
22243 - name: widget-model-version
22245 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
22248 - name: prov-status
22250 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22255 description: UUID of the logical-link, SDNC generates this.
22260 description: Circuit id
22265 description: Reason for this entity, role it is playing
22271 summary: create or update an existing logical-link
22273 Create or update an existing logical-link.
22275 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22276 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
22285 description: Response codes found in [response codes](https://wiki.onap.org/).
22289 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22292 example: __LINK-NAME__
22295 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)
22298 $ref: "#/definitions/logical-link"
22302 summary: update an existing logical-link
22304 Update an existing logical-link
22306 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22307 The PUT operation will entirely replace an existing object.
22308 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22310 Other differences between PUT and PATCH are:
22312 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22313 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22314 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22315 operationId: UpdateNetworkLogicalLinksLogicalLink
22324 description: Response codes found in [response codes](https://wiki.onap.org/).
22328 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22331 example: __LINK-NAME__
22334 description: logical-link object that needs to be created or updated.
22337 $ref: "#/patchDefinitions/logical-link"
22341 summary: delete an existing logical-link
22342 description: delete an existing logical-link
22343 operationId: deleteNetworkLogicalLinksLogicalLink
22352 description: Response codes found in [response codes](https://wiki.onap.org/).
22356 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22359 example: __LINK-NAME__
22360 - name: resource-version
22362 description: resource-version for concurrency
22365 /network/logical-links:
22369 summary: returns logical-links
22370 description: returns logical-links
22371 operationId: getNetworkLogicalLinks
22377 description: successful operation
22379 $ref: "#/getDefinitions/logical-links"
22381 description: Response codes found in [response codes](https://wiki.onap.org/).
22382 /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:
22386 summary: see node definition for valid relationships
22387 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
22396 description: Response codes found in [response codes](https://wiki.onap.org/).
22398 - name: site-pair-set-id
22400 description: Unique id of site pair set.
22403 example: __SITE-PAIR-SET-ID__
22404 - name: routing-instance-id
22406 description: Unique id of routing instance
22409 example: __ROUTING-INSTANCE-ID__
22410 - name: site-pair-id
22412 description: unique identifier of probe
22415 example: __SITE-PAIR-ID__
22418 description: unique identifier of probe
22424 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
22427 $ref: "#/definitions/relationship"
22431 summary: delete an existing relationship
22432 description: delete an existing relationship
22433 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
22442 description: Response codes found in [response codes](https://wiki.onap.org/).
22444 - name: site-pair-set-id
22446 description: Unique id of site pair set.
22449 example: __SITE-PAIR-SET-ID__
22450 - name: routing-instance-id
22452 description: Unique id of routing instance
22455 example: __ROUTING-INSTANCE-ID__
22456 - name: site-pair-id
22458 description: unique identifier of probe
22461 example: __SITE-PAIR-ID__
22464 description: unique identifier of probe
22468 /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}:
22472 summary: returns class-of-service
22473 description: returns class-of-service
22474 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22480 description: successful operation
22482 $ref: "#/getDefinitions/class-of-service"
22484 description: Response codes found in [response codes](https://wiki.onap.org/).
22486 - name: site-pair-set-id
22488 description: Unique id of site pair set.
22491 example: __SITE-PAIR-SET-ID__
22492 - name: routing-instance-id
22494 description: Unique id of routing instance
22497 example: __ROUTING-INSTANCE-ID__
22498 - name: site-pair-id
22500 description: unique identifier of probe
22503 example: __SITE-PAIR-ID__
22506 description: unique identifier of probe
22513 summary: create or update an existing class-of-service
22515 Create or update an existing class-of-service.
22517 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22518 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22527 description: Response codes found in [response codes](https://wiki.onap.org/).
22529 - name: site-pair-set-id
22531 description: Unique id of site pair set.
22534 example: __SITE-PAIR-SET-ID__
22535 - name: routing-instance-id
22537 description: Unique id of routing instance
22540 example: __ROUTING-INSTANCE-ID__
22541 - name: site-pair-id
22543 description: unique identifier of probe
22546 example: __SITE-PAIR-ID__
22549 description: unique identifier of probe
22555 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
22558 $ref: "#/definitions/class-of-service"
22562 summary: update an existing class-of-service
22564 Update an existing class-of-service
22566 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22567 The PUT operation will entirely replace an existing object.
22568 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22570 Other differences between PUT and PATCH are:
22572 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22573 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22574 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22575 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22584 description: Response codes found in [response codes](https://wiki.onap.org/).
22586 - name: site-pair-set-id
22588 description: Unique id of site pair set.
22591 example: __SITE-PAIR-SET-ID__
22592 - name: routing-instance-id
22594 description: Unique id of routing instance
22597 example: __ROUTING-INSTANCE-ID__
22598 - name: site-pair-id
22600 description: unique identifier of probe
22603 example: __SITE-PAIR-ID__
22606 description: unique identifier of probe
22612 description: class-of-service object that needs to be created or updated.
22615 $ref: "#/patchDefinitions/class-of-service"
22619 summary: delete an existing class-of-service
22620 description: delete an existing class-of-service
22621 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22630 description: Response codes found in [response codes](https://wiki.onap.org/).
22632 - name: site-pair-set-id
22634 description: Unique id of site pair set.
22637 example: __SITE-PAIR-SET-ID__
22638 - name: routing-instance-id
22640 description: Unique id of routing instance
22643 example: __ROUTING-INSTANCE-ID__
22644 - name: site-pair-id
22646 description: unique identifier of probe
22649 example: __SITE-PAIR-ID__
22652 description: unique identifier of probe
22656 - name: resource-version
22658 description: resource-version for concurrency
22661 /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:
22665 summary: returns classes-of-service
22666 description: returns classes-of-service
22667 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
22673 description: successful operation
22675 $ref: "#/getDefinitions/classes-of-service"
22677 description: Response codes found in [response codes](https://wiki.onap.org/).
22679 - name: site-pair-set-id
22681 description: Unique id of site pair set.
22684 example: __SITE-PAIR-SET-ID__
22685 - name: routing-instance-id
22687 description: Unique id of routing instance
22690 example: __ROUTING-INSTANCE-ID__
22691 - name: site-pair-id
22693 description: unique identifier of probe
22696 example: __SITE-PAIR-ID__
22697 /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:
22701 summary: see node definition for valid relationships
22702 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
22711 description: Response codes found in [response codes](https://wiki.onap.org/).
22713 - name: site-pair-set-id
22715 description: Unique id of site pair set.
22718 example: __SITE-PAIR-SET-ID__
22719 - name: routing-instance-id
22721 description: Unique id of routing instance
22724 example: __ROUTING-INSTANCE-ID__
22725 - name: site-pair-id
22727 description: unique identifier of probe
22730 example: __SITE-PAIR-ID__
22733 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
22736 $ref: "#/definitions/relationship"
22740 summary: delete an existing relationship
22741 description: delete an existing relationship
22742 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
22751 description: Response codes found in [response codes](https://wiki.onap.org/).
22753 - name: site-pair-set-id
22755 description: Unique id of site pair set.
22758 example: __SITE-PAIR-SET-ID__
22759 - name: routing-instance-id
22761 description: Unique id of routing instance
22764 example: __ROUTING-INSTANCE-ID__
22765 - name: site-pair-id
22767 description: unique identifier of probe
22770 example: __SITE-PAIR-ID__
22771 /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}:
22775 summary: returns site-pair
22776 description: returns site-pair
22777 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22783 description: successful operation
22785 $ref: "#/getDefinitions/site-pair"
22787 description: Response codes found in [response codes](https://wiki.onap.org/).
22789 - name: site-pair-set-id
22791 description: Unique id of site pair set.
22794 example: __SITE-PAIR-SET-ID__
22795 - name: routing-instance-id
22797 description: Unique id of routing instance
22800 example: __ROUTING-INSTANCE-ID__
22801 - name: site-pair-id
22803 description: unique identifier of probe
22806 example: __SITE-PAIR-ID__
22810 summary: create or update an existing site-pair
22812 Create or update an existing site-pair.
22814 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22815 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22824 description: Response codes found in [response codes](https://wiki.onap.org/).
22826 - name: site-pair-set-id
22828 description: Unique id of site pair set.
22831 example: __SITE-PAIR-SET-ID__
22832 - name: routing-instance-id
22834 description: Unique id of routing instance
22837 example: __ROUTING-INSTANCE-ID__
22838 - name: site-pair-id
22840 description: unique identifier of probe
22843 example: __SITE-PAIR-ID__
22846 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
22849 $ref: "#/definitions/site-pair"
22853 summary: update an existing site-pair
22855 Update an existing site-pair
22857 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22858 The PUT operation will entirely replace an existing object.
22859 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22861 Other differences between PUT and PATCH are:
22863 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22864 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22865 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22866 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22875 description: Response codes found in [response codes](https://wiki.onap.org/).
22877 - name: site-pair-set-id
22879 description: Unique id of site pair set.
22882 example: __SITE-PAIR-SET-ID__
22883 - name: routing-instance-id
22885 description: Unique id of routing instance
22888 example: __ROUTING-INSTANCE-ID__
22889 - name: site-pair-id
22891 description: unique identifier of probe
22894 example: __SITE-PAIR-ID__
22897 description: site-pair object that needs to be created or updated.
22900 $ref: "#/patchDefinitions/site-pair"
22904 summary: delete an existing site-pair
22905 description: delete an existing site-pair
22906 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22915 description: Response codes found in [response codes](https://wiki.onap.org/).
22917 - name: site-pair-set-id
22919 description: Unique id of site pair set.
22922 example: __SITE-PAIR-SET-ID__
22923 - name: routing-instance-id
22925 description: Unique id of routing instance
22928 example: __ROUTING-INSTANCE-ID__
22929 - name: site-pair-id
22931 description: unique identifier of probe
22934 example: __SITE-PAIR-ID__
22935 - name: resource-version
22937 description: resource-version for concurrency
22940 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
22944 summary: returns site-pairs
22945 description: returns site-pairs
22946 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
22952 description: successful operation
22954 $ref: "#/getDefinitions/site-pairs"
22956 description: Response codes found in [response codes](https://wiki.onap.org/).
22958 - name: site-pair-set-id
22960 description: Unique id of site pair set.
22963 example: __SITE-PAIR-SET-ID__
22964 - name: routing-instance-id
22966 description: Unique id of routing instance
22969 example: __ROUTING-INSTANCE-ID__
22970 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
22974 summary: see node definition for valid relationships
22975 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
22984 description: Response codes found in [response codes](https://wiki.onap.org/).
22986 - name: site-pair-set-id
22988 description: Unique id of site pair set.
22991 example: __SITE-PAIR-SET-ID__
22992 - name: routing-instance-id
22994 description: Unique id of routing instance
22997 example: __ROUTING-INSTANCE-ID__
23000 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
23003 $ref: "#/definitions/relationship"
23007 summary: delete an existing relationship
23008 description: delete an existing relationship
23009 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
23018 description: Response codes found in [response codes](https://wiki.onap.org/).
23020 - name: site-pair-set-id
23022 description: Unique id of site pair set.
23025 example: __SITE-PAIR-SET-ID__
23026 - name: routing-instance-id
23028 description: Unique id of routing instance
23031 example: __ROUTING-INSTANCE-ID__
23032 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
23036 summary: returns routing-instance
23037 description: returns routing-instance
23038 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23044 description: successful operation
23046 $ref: "#/getDefinitions/routing-instance"
23048 description: Response codes found in [response codes](https://wiki.onap.org/).
23050 - name: site-pair-set-id
23052 description: Unique id of site pair set.
23055 example: __SITE-PAIR-SET-ID__
23056 - name: routing-instance-id
23058 description: Unique id of routing instance
23061 example: __ROUTING-INSTANCE-ID__
23065 summary: create or update an existing routing-instance
23067 Create or update an existing routing-instance.
23069 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23070 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23079 description: Response codes found in [response codes](https://wiki.onap.org/).
23081 - name: site-pair-set-id
23083 description: Unique id of site pair set.
23086 example: __SITE-PAIR-SET-ID__
23087 - name: routing-instance-id
23089 description: Unique id of routing instance
23092 example: __ROUTING-INSTANCE-ID__
23095 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
23098 $ref: "#/definitions/routing-instance"
23102 summary: update an existing routing-instance
23104 Update an existing routing-instance
23106 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23107 The PUT operation will entirely replace an existing object.
23108 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23110 Other differences between PUT and PATCH are:
23112 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23113 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23114 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23115 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23124 description: Response codes found in [response codes](https://wiki.onap.org/).
23126 - name: site-pair-set-id
23128 description: Unique id of site pair set.
23131 example: __SITE-PAIR-SET-ID__
23132 - name: routing-instance-id
23134 description: Unique id of routing instance
23137 example: __ROUTING-INSTANCE-ID__
23140 description: routing-instance object that needs to be created or updated.
23143 $ref: "#/patchDefinitions/routing-instance"
23147 summary: delete an existing routing-instance
23148 description: delete an existing routing-instance
23149 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23158 description: Response codes found in [response codes](https://wiki.onap.org/).
23160 - name: site-pair-set-id
23162 description: Unique id of site pair set.
23165 example: __SITE-PAIR-SET-ID__
23166 - name: routing-instance-id
23168 description: Unique id of routing instance
23171 example: __ROUTING-INSTANCE-ID__
23172 - name: resource-version
23174 description: resource-version for concurrency
23177 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
23181 summary: returns routing-instances
23182 description: returns routing-instances
23183 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
23189 description: successful operation
23191 $ref: "#/getDefinitions/routing-instances"
23193 description: Response codes found in [response codes](https://wiki.onap.org/).
23195 - name: site-pair-set-id
23197 description: Unique id of site pair set.
23200 example: __SITE-PAIR-SET-ID__
23201 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
23205 summary: see node definition for valid relationships
23206 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
23215 description: Response codes found in [response codes](https://wiki.onap.org/).
23217 - name: site-pair-set-id
23219 description: Unique id of site pair set.
23222 example: __SITE-PAIR-SET-ID__
23225 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)
23228 $ref: "#/definitions/relationship"
23232 summary: delete an existing relationship
23233 description: delete an existing relationship
23234 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
23243 description: Response codes found in [response codes](https://wiki.onap.org/).
23245 - name: site-pair-set-id
23247 description: Unique id of site pair set.
23250 example: __SITE-PAIR-SET-ID__
23251 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
23255 summary: returns site-pair-set
23256 description: returns site-pair-set
23257 operationId: getNetworkSitePairSetsSitePairSet
23263 description: successful operation
23265 $ref: "#/getDefinitions/site-pair-set"
23267 description: Response codes found in [response codes](https://wiki.onap.org/).
23269 - name: site-pair-set-id
23271 description: Unique id of site pair set.
23274 example: __SITE-PAIR-SET-ID__
23278 summary: create or update an existing site-pair-set
23280 Create or update an existing site-pair-set.
23282 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23283 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
23292 description: Response codes found in [response codes](https://wiki.onap.org/).
23294 - name: site-pair-set-id
23296 description: Unique id of site pair set.
23299 example: __SITE-PAIR-SET-ID__
23302 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)
23305 $ref: "#/definitions/site-pair-set"
23309 summary: update an existing site-pair-set
23311 Update an existing site-pair-set
23313 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23314 The PUT operation will entirely replace an existing object.
23315 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23317 Other differences between PUT and PATCH are:
23319 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23320 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23321 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23322 operationId: UpdateNetworkSitePairSetsSitePairSet
23331 description: Response codes found in [response codes](https://wiki.onap.org/).
23333 - name: site-pair-set-id
23335 description: Unique id of site pair set.
23338 example: __SITE-PAIR-SET-ID__
23341 description: site-pair-set object that needs to be created or updated.
23344 $ref: "#/patchDefinitions/site-pair-set"
23348 summary: delete an existing site-pair-set
23349 description: delete an existing site-pair-set
23350 operationId: deleteNetworkSitePairSetsSitePairSet
23359 description: Response codes found in [response codes](https://wiki.onap.org/).
23361 - name: site-pair-set-id
23363 description: Unique id of site pair set.
23366 example: __SITE-PAIR-SET-ID__
23367 - name: resource-version
23369 description: resource-version for concurrency
23372 /network/site-pair-sets:
23376 summary: returns site-pair-sets
23377 description: returns site-pair-sets
23378 operationId: getNetworkSitePairSets
23384 description: successful operation
23386 $ref: "#/getDefinitions/site-pair-sets"
23388 description: Response codes found in [response codes](https://wiki.onap.org/).
23389 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
23393 summary: see node definition for valid relationships
23394 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
23403 description: Response codes found in [response codes](https://wiki.onap.org/).
23407 description: VPN ID, globally unique within A&AI
23410 example: __VPN-ID__
23411 - name: global-route-target
23413 description: Number used to identify an RT, globally unique in the network
23416 example: __GLOBAL-ROUTE-TARGET__
23417 - name: route-target-role
23419 description: Role assigned to this route target
23422 example: __ROUTE-TARGET-ROLE__
23425 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
23428 $ref: "#/definitions/relationship"
23432 summary: delete an existing relationship
23433 description: delete an existing relationship
23434 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
23443 description: Response codes found in [response codes](https://wiki.onap.org/).
23447 description: VPN ID, globally unique within A&AI
23450 example: __VPN-ID__
23451 - name: global-route-target
23453 description: Number used to identify an RT, globally unique in the network
23456 example: __GLOBAL-ROUTE-TARGET__
23457 - name: route-target-role
23459 description: Role assigned to this route target
23462 example: __ROUTE-TARGET-ROLE__
23463 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
23467 summary: returns route-target
23468 description: returns route-target
23469 operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23475 description: successful operation
23477 $ref: "#/getDefinitions/route-target"
23479 description: Response codes found in [response codes](https://wiki.onap.org/).
23483 description: VPN ID, globally unique within A&AI
23486 example: __VPN-ID__
23487 - name: global-route-target
23489 description: Number used to identify an RT, globally unique in the network
23492 example: __GLOBAL-ROUTE-TARGET__
23493 - name: route-target-role
23495 description: Role assigned to this route target
23498 example: __ROUTE-TARGET-ROLE__
23501 description: VPN Name
23506 description: Type of the vpn, should be taken from enumerated/valid values
23512 summary: create or update an existing route-target
23514 Create or update an existing route-target.
23516 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23517 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23526 description: Response codes found in [response codes](https://wiki.onap.org/).
23530 description: VPN ID, globally unique within A&AI
23533 example: __VPN-ID__
23534 - name: global-route-target
23536 description: Number used to identify an RT, globally unique in the network
23539 example: __GLOBAL-ROUTE-TARGET__
23540 - name: route-target-role
23542 description: Role assigned to this route target
23545 example: __ROUTE-TARGET-ROLE__
23548 description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
23551 $ref: "#/definitions/route-target"
23555 summary: update an existing route-target
23557 Update an existing route-target
23559 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23560 The PUT operation will entirely replace an existing object.
23561 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23563 Other differences between PUT and PATCH are:
23565 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23566 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23567 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23568 operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23577 description: Response codes found in [response codes](https://wiki.onap.org/).
23581 description: VPN ID, globally unique within A&AI
23584 example: __VPN-ID__
23585 - name: global-route-target
23587 description: Number used to identify an RT, globally unique in the network
23590 example: __GLOBAL-ROUTE-TARGET__
23591 - name: route-target-role
23593 description: Role assigned to this route target
23596 example: __ROUTE-TARGET-ROLE__
23599 description: route-target object that needs to be created or updated.
23602 $ref: "#/patchDefinitions/route-target"
23606 summary: delete an existing route-target
23607 description: delete an existing route-target
23608 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23617 description: Response codes found in [response codes](https://wiki.onap.org/).
23621 description: VPN ID, globally unique within A&AI
23624 example: __VPN-ID__
23625 - name: global-route-target
23627 description: Number used to identify an RT, globally unique in the network
23630 example: __GLOBAL-ROUTE-TARGET__
23631 - name: route-target-role
23633 description: Role assigned to this route target
23636 example: __ROUTE-TARGET-ROLE__
23637 - name: resource-version
23639 description: resource-version for concurrency
23642 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
23646 summary: returns route-targets
23647 description: returns route-targets
23648 operationId: getNetworkVpnBindingsVpnBindingRouteTargets
23654 description: successful operation
23656 $ref: "#/getDefinitions/route-targets"
23658 description: Response codes found in [response codes](https://wiki.onap.org/).
23662 description: VPN ID, globally unique within A&AI
23665 example: __VPN-ID__
23668 description: VPN Name
23673 description: Type of the vpn, should be taken from enumerated/valid values
23676 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
23680 summary: see node definition for valid relationships
23681 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
23690 description: Response codes found in [response codes](https://wiki.onap.org/).
23694 description: VPN ID, globally unique within A&AI
23697 example: __VPN-ID__
23700 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)
23703 $ref: "#/definitions/relationship"
23707 summary: delete an existing relationship
23708 description: delete an existing relationship
23709 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
23718 description: Response codes found in [response codes](https://wiki.onap.org/).
23722 description: VPN ID, globally unique within A&AI
23725 example: __VPN-ID__
23726 /network/vpn-bindings/vpn-binding/{vpn-id}:
23730 summary: returns vpn-binding
23731 description: returns vpn-binding
23732 operationId: getNetworkVpnBindingsVpnBinding
23738 description: successful operation
23740 $ref: "#/getDefinitions/vpn-binding"
23742 description: Response codes found in [response codes](https://wiki.onap.org/).
23746 description: VPN ID, globally unique within A&AI
23749 example: __VPN-ID__
23752 description: VPN Name
23757 description: Type of the vpn, should be taken from enumerated/valid values
23763 summary: create or update an existing vpn-binding
23765 Create or update an existing vpn-binding.
23767 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23768 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
23777 description: Response codes found in [response codes](https://wiki.onap.org/).
23781 description: VPN ID, globally unique within A&AI
23784 example: __VPN-ID__
23787 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)
23790 $ref: "#/definitions/vpn-binding"
23794 summary: update an existing vpn-binding
23796 Update an existing vpn-binding
23798 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23799 The PUT operation will entirely replace an existing object.
23800 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23802 Other differences between PUT and PATCH are:
23804 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23805 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23806 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23807 operationId: UpdateNetworkVpnBindingsVpnBinding
23816 description: Response codes found in [response codes](https://wiki.onap.org/).
23820 description: VPN ID, globally unique within A&AI
23823 example: __VPN-ID__
23826 description: vpn-binding object that needs to be created or updated.
23829 $ref: "#/patchDefinitions/vpn-binding"
23833 summary: delete an existing vpn-binding
23834 description: delete an existing vpn-binding
23835 operationId: deleteNetworkVpnBindingsVpnBinding
23844 description: Response codes found in [response codes](https://wiki.onap.org/).
23848 description: VPN ID, globally unique within A&AI
23851 example: __VPN-ID__
23852 - name: resource-version
23854 description: resource-version for concurrency
23857 /network/vpn-bindings:
23861 summary: returns vpn-bindings
23862 description: returns vpn-bindings
23863 operationId: getNetworkVpnBindings
23869 description: successful operation
23871 $ref: "#/getDefinitions/vpn-bindings"
23873 description: Response codes found in [response codes](https://wiki.onap.org/).
23874 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
23878 summary: see node definition for valid relationships
23879 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
23888 description: Response codes found in [response codes](https://wiki.onap.org/).
23890 - name: equipment-name
23894 example: __EQUIPMENT-NAME__
23897 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)
23900 $ref: "#/definitions/relationship"
23904 summary: delete an existing relationship
23905 description: delete an existing relationship
23906 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
23915 description: Response codes found in [response codes](https://wiki.onap.org/).
23917 - name: equipment-name
23921 example: __EQUIPMENT-NAME__
23922 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
23926 summary: see node definition for valid relationships
23927 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
23936 description: Response codes found in [response codes](https://wiki.onap.org/).
23938 - name: equipment-name
23942 example: __EQUIPMENT-NAME__
23943 - name: interface-name
23945 description: Name that identifies the physical interface
23948 example: __INTERFACE-NAME__
23951 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)
23954 $ref: "#/definitions/relationship"
23958 summary: delete an existing relationship
23959 description: delete an existing relationship
23960 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
23969 description: Response codes found in [response codes](https://wiki.onap.org/).
23971 - name: equipment-name
23975 example: __EQUIPMENT-NAME__
23976 - name: interface-name
23978 description: Name that identifies the physical interface
23981 example: __INTERFACE-NAME__
23982 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
23986 summary: see node definition for valid relationships
23987 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
23996 description: Response codes found in [response codes](https://wiki.onap.org/).
23998 - name: equipment-name
24002 example: __EQUIPMENT-NAME__
24003 - name: interface-name
24005 description: Name that identifies the physical interface
24008 example: __INTERFACE-NAME__
24011 description: Identifier for the sriov-pf
24014 example: __PF-PCI-ID__
24017 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
24020 $ref: "#/definitions/relationship"
24024 summary: delete an existing relationship
24025 description: delete an existing relationship
24026 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
24035 description: Response codes found in [response codes](https://wiki.onap.org/).
24037 - name: equipment-name
24041 example: __EQUIPMENT-NAME__
24042 - name: interface-name
24044 description: Name that identifies the physical interface
24047 example: __INTERFACE-NAME__
24050 description: Identifier for the sriov-pf
24053 example: __PF-PCI-ID__
24054 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
24058 summary: returns sriov-pf
24059 description: returns sriov-pf
24060 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24066 description: successful operation
24068 $ref: "#/getDefinitions/sriov-pf"
24070 description: Response codes found in [response codes](https://wiki.onap.org/).
24072 - name: equipment-name
24076 example: __EQUIPMENT-NAME__
24077 - name: interface-name
24079 description: Name that identifies the physical interface
24082 example: __INTERFACE-NAME__
24085 description: Identifier for the sriov-pf
24088 example: __PF-PCI-ID__
24089 - name: prov-status
24091 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24094 - name: prov-status
24096 description: Trigger for operational monitoring of this resource by Service Assurance systems.
24102 summary: create or update an existing sriov-pf
24104 Create or update an existing sriov-pf.
24106 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24107 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24116 description: Response codes found in [response codes](https://wiki.onap.org/).
24118 - name: equipment-name
24122 example: __EQUIPMENT-NAME__
24123 - name: interface-name
24125 description: Name that identifies the physical interface
24128 example: __INTERFACE-NAME__
24131 description: Identifier for the sriov-pf
24134 example: __PF-PCI-ID__
24137 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
24140 $ref: "#/definitions/sriov-pf"
24144 summary: update an existing sriov-pf
24146 Update an existing sriov-pf
24148 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24149 The PUT operation will entirely replace an existing object.
24150 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24152 Other differences between PUT and PATCH are:
24154 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24155 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24156 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24157 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24166 description: Response codes found in [response codes](https://wiki.onap.org/).
24168 - name: equipment-name
24172 example: __EQUIPMENT-NAME__
24173 - name: interface-name
24175 description: Name that identifies the physical interface
24178 example: __INTERFACE-NAME__
24181 description: Identifier for the sriov-pf
24184 example: __PF-PCI-ID__
24187 description: sriov-pf object that needs to be created or updated.
24190 $ref: "#/patchDefinitions/sriov-pf"
24194 summary: delete an existing sriov-pf
24195 description: delete an existing sriov-pf
24196 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24205 description: Response codes found in [response codes](https://wiki.onap.org/).
24207 - name: equipment-name
24211 example: __EQUIPMENT-NAME__
24212 - name: interface-name
24214 description: Name that identifies the physical interface
24217 example: __INTERFACE-NAME__
24220 description: Identifier for the sriov-pf
24223 example: __PF-PCI-ID__
24224 - name: resource-version
24226 description: resource-version for concurrency
24229 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
24233 summary: returns sriov-pfs
24234 description: returns sriov-pfs
24235 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
24241 description: successful operation
24243 $ref: "#/getDefinitions/sriov-pfs"
24245 description: Response codes found in [response codes](https://wiki.onap.org/).
24247 - name: equipment-name
24251 example: __EQUIPMENT-NAME__
24252 - name: interface-name
24254 description: Name that identifies the physical interface
24257 example: __INTERFACE-NAME__
24258 - name: prov-status
24260 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24263 - name: prov-status
24265 description: Trigger for operational monitoring of this resource by Service Assurance systems.
24268 /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:
24272 summary: see node definition for valid relationships
24273 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24282 description: Response codes found in [response codes](https://wiki.onap.org/).
24284 - name: equipment-name
24288 example: __EQUIPMENT-NAME__
24289 - name: interface-name
24291 description: Name that identifies the physical interface
24294 example: __INTERFACE-NAME__
24295 - name: interface-name
24297 description: Name given to the interface
24300 example: __INTERFACE-NAME__
24301 - name: vlan-interface
24303 description: String that identifies the interface
24306 example: __VLAN-INTERFACE__
24309 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
24312 $ref: "#/definitions/relationship"
24316 summary: delete an existing relationship
24317 description: delete an existing relationship
24318 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24327 description: Response codes found in [response codes](https://wiki.onap.org/).
24329 - name: equipment-name
24333 example: __EQUIPMENT-NAME__
24334 - name: interface-name
24336 description: Name that identifies the physical interface
24339 example: __INTERFACE-NAME__
24340 - name: interface-name
24342 description: Name given to the interface
24345 example: __INTERFACE-NAME__
24346 - name: vlan-interface
24348 description: String that identifies the interface
24351 example: __VLAN-INTERFACE__
24352 /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:
24356 summary: see node definition for valid relationships
24357 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24366 description: Response codes found in [response codes](https://wiki.onap.org/).
24368 - name: equipment-name
24372 example: __EQUIPMENT-NAME__
24373 - name: interface-name
24375 description: Name that identifies the physical interface
24378 example: __INTERFACE-NAME__
24379 - name: interface-name
24381 description: Name given to the interface
24384 example: __INTERFACE-NAME__
24385 - name: vlan-interface
24387 description: String that identifies the interface
24390 example: __VLAN-INTERFACE__
24391 - name: l3-interface-ipv4-address
24393 description: IP address
24396 example: __L3-INTERFACE-IPV4-ADDRESS__
24399 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24402 $ref: "#/definitions/relationship"
24406 summary: delete an existing relationship
24407 description: delete an existing relationship
24408 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24417 description: Response codes found in [response codes](https://wiki.onap.org/).
24419 - name: equipment-name
24423 example: __EQUIPMENT-NAME__
24424 - name: interface-name
24426 description: Name that identifies the physical interface
24429 example: __INTERFACE-NAME__
24430 - name: interface-name
24432 description: Name given to the interface
24435 example: __INTERFACE-NAME__
24436 - name: vlan-interface
24438 description: String that identifies the interface
24441 example: __VLAN-INTERFACE__
24442 - name: l3-interface-ipv4-address
24444 description: IP address
24447 example: __L3-INTERFACE-IPV4-ADDRESS__
24448 /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}:
24452 summary: returns l3-interface-ipv4-address-list
24453 description: returns l3-interface-ipv4-address-list
24454 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24460 description: successful operation
24462 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24464 description: Response codes found in [response codes](https://wiki.onap.org/).
24466 - name: equipment-name
24470 example: __EQUIPMENT-NAME__
24471 - name: interface-name
24473 description: Name that identifies the physical interface
24476 example: __INTERFACE-NAME__
24477 - name: interface-name
24479 description: Name given to the interface
24482 example: __INTERFACE-NAME__
24483 - name: vlan-interface
24485 description: String that identifies the interface
24488 example: __VLAN-INTERFACE__
24489 - name: l3-interface-ipv4-address
24491 description: IP address
24494 example: __L3-INTERFACE-IPV4-ADDRESS__
24495 - name: prov-status
24497 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24500 - name: prov-status
24502 description: Trigger for operational monitoring of this resource by Service Assurance systems.
24505 - name: interface-id
24507 description: ID of interface
24512 description: MAC address for the interface
24515 - name: network-name
24517 description: Name of the network
24520 - name: vlan-id-inner
24522 description: Inner VLAN tag
24528 description: This indicates the customers VPN ID associated with this vlan
24531 - name: vlan-id-inner
24533 description: Inner VLAN tag
24537 - name: neutron-network-id
24539 description: Neutron network id of the interface that address belongs to
24542 - name: neutron-subnet-id
24544 description: Neutron id of subnet that address belongs to
24550 summary: create or update an existing l3-interface-ipv4-address-list
24552 Create or update an existing l3-interface-ipv4-address-list.
24554 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24555 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24564 description: Response codes found in [response codes](https://wiki.onap.org/).
24566 - name: equipment-name
24570 example: __EQUIPMENT-NAME__
24571 - name: interface-name
24573 description: Name that identifies the physical interface
24576 example: __INTERFACE-NAME__
24577 - name: interface-name
24579 description: Name given to the interface
24582 example: __INTERFACE-NAME__
24583 - name: vlan-interface
24585 description: String that identifies the interface
24588 example: __VLAN-INTERFACE__
24589 - name: l3-interface-ipv4-address
24591 description: IP address
24594 example: __L3-INTERFACE-IPV4-ADDRESS__
24597 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24600 $ref: "#/definitions/l3-interface-ipv4-address-list"
24604 summary: update an existing l3-interface-ipv4-address-list
24606 Update an existing l3-interface-ipv4-address-list
24608 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24609 The PUT operation will entirely replace an existing object.
24610 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24612 Other differences between PUT and PATCH are:
24614 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24615 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24616 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24617 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24626 description: Response codes found in [response codes](https://wiki.onap.org/).
24628 - name: equipment-name
24632 example: __EQUIPMENT-NAME__
24633 - name: interface-name
24635 description: Name that identifies the physical interface
24638 example: __INTERFACE-NAME__
24639 - name: interface-name
24641 description: Name given to the interface
24644 example: __INTERFACE-NAME__
24645 - name: vlan-interface
24647 description: String that identifies the interface
24650 example: __VLAN-INTERFACE__
24651 - name: l3-interface-ipv4-address
24653 description: IP address
24656 example: __L3-INTERFACE-IPV4-ADDRESS__
24659 description: l3-interface-ipv4-address-list object that needs to be created or updated.
24662 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24666 summary: delete an existing l3-interface-ipv4-address-list
24667 description: delete an existing l3-interface-ipv4-address-list
24668 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24677 description: Response codes found in [response codes](https://wiki.onap.org/).
24679 - name: equipment-name
24683 example: __EQUIPMENT-NAME__
24684 - name: interface-name
24686 description: Name that identifies the physical interface
24689 example: __INTERFACE-NAME__
24690 - name: interface-name
24692 description: Name given to the interface
24695 example: __INTERFACE-NAME__
24696 - name: vlan-interface
24698 description: String that identifies the interface
24701 example: __VLAN-INTERFACE__
24702 - name: l3-interface-ipv4-address
24704 description: IP address
24707 example: __L3-INTERFACE-IPV4-ADDRESS__
24708 - name: resource-version
24710 description: resource-version for concurrency
24713 /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:
24717 summary: see node definition for valid relationships
24718 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24727 description: Response codes found in [response codes](https://wiki.onap.org/).
24729 - name: equipment-name
24733 example: __EQUIPMENT-NAME__
24734 - name: interface-name
24736 description: Name that identifies the physical interface
24739 example: __INTERFACE-NAME__
24740 - name: interface-name
24742 description: Name given to the interface
24745 example: __INTERFACE-NAME__
24746 - name: vlan-interface
24748 description: String that identifies the interface
24751 example: __VLAN-INTERFACE__
24752 - name: l3-interface-ipv6-address
24754 description: IP address
24757 example: __L3-INTERFACE-IPV6-ADDRESS__
24760 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24763 $ref: "#/definitions/relationship"
24767 summary: delete an existing relationship
24768 description: delete an existing relationship
24769 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24778 description: Response codes found in [response codes](https://wiki.onap.org/).
24780 - name: equipment-name
24784 example: __EQUIPMENT-NAME__
24785 - name: interface-name
24787 description: Name that identifies the physical interface
24790 example: __INTERFACE-NAME__
24791 - name: interface-name
24793 description: Name given to the interface
24796 example: __INTERFACE-NAME__
24797 - name: vlan-interface
24799 description: String that identifies the interface
24802 example: __VLAN-INTERFACE__
24803 - name: l3-interface-ipv6-address
24805 description: IP address
24808 example: __L3-INTERFACE-IPV6-ADDRESS__
24809 /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}:
24813 summary: returns l3-interface-ipv6-address-list
24814 description: returns l3-interface-ipv6-address-list
24815 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24821 description: successful operation
24823 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24825 description: Response codes found in [response codes](https://wiki.onap.org/).
24827 - name: equipment-name
24831 example: __EQUIPMENT-NAME__
24832 - name: interface-name
24834 description: Name that identifies the physical interface
24837 example: __INTERFACE-NAME__
24838 - name: interface-name
24840 description: Name given to the interface
24843 example: __INTERFACE-NAME__
24844 - name: vlan-interface
24846 description: String that identifies the interface
24849 example: __VLAN-INTERFACE__
24850 - name: l3-interface-ipv6-address
24852 description: IP address
24855 example: __L3-INTERFACE-IPV6-ADDRESS__
24856 - name: prov-status
24858 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24861 - name: prov-status
24863 description: Trigger for operational monitoring of this resource by Service Assurance systems.
24866 - name: interface-id
24868 description: ID of interface
24873 description: MAC address for the interface
24876 - name: network-name
24878 description: Name of the network
24881 - name: vlan-id-inner
24883 description: Inner VLAN tag
24889 description: This indicates the customers VPN ID associated with this vlan
24892 - name: vlan-id-inner
24894 description: Inner VLAN tag
24898 - name: neutron-network-id
24900 description: Neutron network id of the interface that address belongs to
24903 - name: neutron-subnet-id
24905 description: Neutron id of subnet that address belongs to
24911 summary: create or update an existing l3-interface-ipv6-address-list
24913 Create or update an existing l3-interface-ipv6-address-list.
24915 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24916 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24925 description: Response codes found in [response codes](https://wiki.onap.org/).
24927 - name: equipment-name
24931 example: __EQUIPMENT-NAME__
24932 - name: interface-name
24934 description: Name that identifies the physical interface
24937 example: __INTERFACE-NAME__
24938 - name: interface-name
24940 description: Name given to the interface
24943 example: __INTERFACE-NAME__
24944 - name: vlan-interface
24946 description: String that identifies the interface
24949 example: __VLAN-INTERFACE__
24950 - name: l3-interface-ipv6-address
24952 description: IP address
24955 example: __L3-INTERFACE-IPV6-ADDRESS__
24958 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24961 $ref: "#/definitions/l3-interface-ipv6-address-list"
24965 summary: update an existing l3-interface-ipv6-address-list
24967 Update an existing l3-interface-ipv6-address-list
24969 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24970 The PUT operation will entirely replace an existing object.
24971 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24973 Other differences between PUT and PATCH are:
24975 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24976 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24977 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24978 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24987 description: Response codes found in [response codes](https://wiki.onap.org/).
24989 - name: equipment-name
24993 example: __EQUIPMENT-NAME__
24994 - name: interface-name
24996 description: Name that identifies the physical interface
24999 example: __INTERFACE-NAME__
25000 - name: interface-name
25002 description: Name given to the interface
25005 example: __INTERFACE-NAME__
25006 - name: vlan-interface
25008 description: String that identifies the interface
25011 example: __VLAN-INTERFACE__
25012 - name: l3-interface-ipv6-address
25014 description: IP address
25017 example: __L3-INTERFACE-IPV6-ADDRESS__
25020 description: l3-interface-ipv6-address-list object that needs to be created or updated.
25023 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25027 summary: delete an existing l3-interface-ipv6-address-list
25028 description: delete an existing l3-interface-ipv6-address-list
25029 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25038 description: Response codes found in [response codes](https://wiki.onap.org/).
25040 - name: equipment-name
25044 example: __EQUIPMENT-NAME__
25045 - name: interface-name
25047 description: Name that identifies the physical interface
25050 example: __INTERFACE-NAME__
25051 - name: interface-name
25053 description: Name given to the interface
25056 example: __INTERFACE-NAME__
25057 - name: vlan-interface
25059 description: String that identifies the interface
25062 example: __VLAN-INTERFACE__
25063 - name: l3-interface-ipv6-address
25065 description: IP address
25068 example: __L3-INTERFACE-IPV6-ADDRESS__
25069 - name: resource-version
25071 description: resource-version for concurrency
25074 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25078 summary: returns vlan
25079 description: returns vlan
25080 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25086 description: successful operation
25088 $ref: "#/getDefinitions/vlan"
25090 description: Response codes found in [response codes](https://wiki.onap.org/).
25092 - name: equipment-name
25096 example: __EQUIPMENT-NAME__
25097 - name: interface-name
25099 description: Name that identifies the physical interface
25102 example: __INTERFACE-NAME__
25103 - name: interface-name
25105 description: Name given to the interface
25108 example: __INTERFACE-NAME__
25109 - name: vlan-interface
25111 description: String that identifies the interface
25114 example: __VLAN-INTERFACE__
25115 - name: prov-status
25117 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25120 - name: prov-status
25122 description: Trigger for operational monitoring of this resource by Service Assurance systems.
25125 - name: interface-id
25127 description: ID of interface
25132 description: MAC address for the interface
25135 - name: network-name
25137 description: Name of the network
25140 - name: vlan-id-inner
25142 description: Inner VLAN tag
25148 description: This indicates the customers VPN ID associated with this vlan
25154 summary: create or update an existing vlan
25156 Create or update an existing vlan.
25158 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25159 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25168 description: Response codes found in [response codes](https://wiki.onap.org/).
25170 - name: equipment-name
25174 example: __EQUIPMENT-NAME__
25175 - name: interface-name
25177 description: Name that identifies the physical interface
25180 example: __INTERFACE-NAME__
25181 - name: interface-name
25183 description: Name given to the interface
25186 example: __INTERFACE-NAME__
25187 - name: vlan-interface
25189 description: String that identifies the interface
25192 example: __VLAN-INTERFACE__
25195 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
25198 $ref: "#/definitions/vlan"
25202 summary: update an existing vlan
25204 Update an existing vlan
25206 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25207 The PUT operation will entirely replace an existing object.
25208 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25210 Other differences between PUT and PATCH are:
25212 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25213 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25214 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25215 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25224 description: Response codes found in [response codes](https://wiki.onap.org/).
25226 - name: equipment-name
25230 example: __EQUIPMENT-NAME__
25231 - name: interface-name
25233 description: Name that identifies the physical interface
25236 example: __INTERFACE-NAME__
25237 - name: interface-name
25239 description: Name given to the interface
25242 example: __INTERFACE-NAME__
25243 - name: vlan-interface
25245 description: String that identifies the interface
25248 example: __VLAN-INTERFACE__
25251 description: vlan object that needs to be created or updated.
25254 $ref: "#/patchDefinitions/vlan"
25258 summary: delete an existing vlan
25259 description: delete an existing vlan
25260 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25269 description: Response codes found in [response codes](https://wiki.onap.org/).
25271 - name: equipment-name
25275 example: __EQUIPMENT-NAME__
25276 - name: interface-name
25278 description: Name that identifies the physical interface
25281 example: __INTERFACE-NAME__
25282 - name: interface-name
25284 description: Name given to the interface
25287 example: __INTERFACE-NAME__
25288 - name: vlan-interface
25290 description: String that identifies the interface
25293 example: __VLAN-INTERFACE__
25294 - name: resource-version
25296 description: resource-version for concurrency
25299 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
25303 summary: returns vlans
25304 description: returns vlans
25305 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
25311 description: successful operation
25313 $ref: "#/getDefinitions/vlans"
25315 description: Response codes found in [response codes](https://wiki.onap.org/).
25317 - name: equipment-name
25321 example: __EQUIPMENT-NAME__
25322 - name: interface-name
25324 description: Name that identifies the physical interface
25327 example: __INTERFACE-NAME__
25328 - name: interface-name
25330 description: Name given to the interface
25333 example: __INTERFACE-NAME__
25334 - name: prov-status
25336 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25339 - name: prov-status
25341 description: Trigger for operational monitoring of this resource by Service Assurance systems.
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}/p-interfaces/p-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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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 physical 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/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25403 $ref: "#/definitions/relationship"
25407 summary: delete an existing relationship
25408 description: delete an existing relationship
25409 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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 physical 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}/p-interfaces/p-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: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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 physical 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: prov-status
25491 description: Trigger for operational monitoring of this resource by Service Assurance systems.
25494 - name: interface-id
25496 description: ID of interface
25501 description: MAC address for the interface
25504 - name: network-name
25506 description: Name of the network
25509 - name: vf-vlan-filter
25511 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
25514 - name: vf-mac-filter
25516 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
25519 - name: vf-vlan-strip
25521 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
25524 - name: neutron-network-id
25526 description: Neutron network id of the interface
25532 summary: create or update an existing sriov-vf
25534 Create or update an existing sriov-vf.
25536 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25537 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25546 description: Response codes found in [response codes](https://wiki.onap.org/).
25548 - name: equipment-name
25552 example: __EQUIPMENT-NAME__
25553 - name: interface-name
25555 description: Name that identifies the physical interface
25558 example: __INTERFACE-NAME__
25559 - name: interface-name
25561 description: Name given to the interface
25564 example: __INTERFACE-NAME__
25567 description: PCI ID used to identify the sriov-vf
25570 example: __PCI-ID__
25573 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25576 $ref: "#/definitions/sriov-vf"
25580 summary: update an existing sriov-vf
25582 Update an existing sriov-vf
25584 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25585 The PUT operation will entirely replace an existing object.
25586 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25588 Other differences between PUT and PATCH are:
25590 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25591 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25592 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25593 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25602 description: Response codes found in [response codes](https://wiki.onap.org/).
25604 - name: equipment-name
25608 example: __EQUIPMENT-NAME__
25609 - name: interface-name
25611 description: Name that identifies the physical interface
25614 example: __INTERFACE-NAME__
25615 - name: interface-name
25617 description: Name given to the interface
25620 example: __INTERFACE-NAME__
25623 description: PCI ID used to identify the sriov-vf
25626 example: __PCI-ID__
25629 description: sriov-vf object that needs to be created or updated.
25632 $ref: "#/patchDefinitions/sriov-vf"
25636 summary: delete an existing sriov-vf
25637 description: delete an existing sriov-vf
25638 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25647 description: Response codes found in [response codes](https://wiki.onap.org/).
25649 - name: equipment-name
25653 example: __EQUIPMENT-NAME__
25654 - name: interface-name
25656 description: Name that identifies the physical interface
25659 example: __INTERFACE-NAME__
25660 - name: interface-name
25662 description: Name given to the interface
25665 example: __INTERFACE-NAME__
25668 description: PCI ID used to identify the sriov-vf
25671 example: __PCI-ID__
25672 - name: resource-version
25674 description: resource-version for concurrency
25677 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
25681 summary: returns sriov-vfs
25682 description: returns sriov-vfs
25683 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
25689 description: successful operation
25691 $ref: "#/getDefinitions/sriov-vfs"
25693 description: Response codes found in [response codes](https://wiki.onap.org/).
25695 - name: equipment-name
25699 example: __EQUIPMENT-NAME__
25700 - name: interface-name
25702 description: Name that identifies the physical interface
25705 example: __INTERFACE-NAME__
25706 - name: interface-name
25708 description: Name given to the interface
25711 example: __INTERFACE-NAME__
25712 - name: prov-status
25714 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25717 - name: prov-status
25719 description: Trigger for operational monitoring of this resource by Service Assurance systems.
25722 - name: interface-id
25724 description: ID of interface
25729 description: MAC address for the interface
25732 - name: network-name
25734 description: Name of the network
25737 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
25741 summary: see node definition for valid relationships
25742 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
25751 description: Response codes found in [response codes](https://wiki.onap.org/).
25753 - name: equipment-name
25757 example: __EQUIPMENT-NAME__
25758 - name: interface-name
25760 description: Name that identifies the physical interface
25763 example: __INTERFACE-NAME__
25764 - name: interface-name
25766 description: Name given to the interface
25769 example: __INTERFACE-NAME__
25772 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
25775 $ref: "#/definitions/relationship"
25779 summary: delete an existing relationship
25780 description: delete an existing relationship
25781 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
25790 description: Response codes found in [response codes](https://wiki.onap.org/).
25792 - name: equipment-name
25796 example: __EQUIPMENT-NAME__
25797 - name: interface-name
25799 description: Name that identifies the physical interface
25802 example: __INTERFACE-NAME__
25803 - name: interface-name
25805 description: Name given to the interface
25808 example: __INTERFACE-NAME__
25809 /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:
25813 summary: see node definition for valid relationships
25814 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25823 description: Response codes found in [response codes](https://wiki.onap.org/).
25825 - name: equipment-name
25829 example: __EQUIPMENT-NAME__
25830 - name: interface-name
25832 description: Name that identifies the physical interface
25835 example: __INTERFACE-NAME__
25836 - name: interface-name
25838 description: Name given to the interface
25841 example: __INTERFACE-NAME__
25842 - name: l3-interface-ipv4-address
25844 description: IP address
25847 example: __L3-INTERFACE-IPV4-ADDRESS__
25850 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25853 $ref: "#/definitions/relationship"
25857 summary: delete an existing relationship
25858 description: delete an existing relationship
25859 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25868 description: Response codes found in [response codes](https://wiki.onap.org/).
25870 - name: equipment-name
25874 example: __EQUIPMENT-NAME__
25875 - name: interface-name
25877 description: Name that identifies the physical interface
25880 example: __INTERFACE-NAME__
25881 - name: interface-name
25883 description: Name given to the interface
25886 example: __INTERFACE-NAME__
25887 - name: l3-interface-ipv4-address
25889 description: IP address
25892 example: __L3-INTERFACE-IPV4-ADDRESS__
25893 /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}:
25897 summary: returns l3-interface-ipv4-address-list
25898 description: returns l3-interface-ipv4-address-list
25899 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25905 description: successful operation
25907 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25909 description: Response codes found in [response codes](https://wiki.onap.org/).
25911 - name: equipment-name
25915 example: __EQUIPMENT-NAME__
25916 - name: interface-name
25918 description: Name that identifies the physical interface
25921 example: __INTERFACE-NAME__
25922 - name: interface-name
25924 description: Name given to the interface
25927 example: __INTERFACE-NAME__
25928 - name: l3-interface-ipv4-address
25930 description: IP address
25933 example: __L3-INTERFACE-IPV4-ADDRESS__
25934 - name: prov-status
25936 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25939 - name: prov-status
25941 description: Trigger for operational monitoring of this resource by Service Assurance systems.
25944 - name: interface-id
25946 description: ID of interface
25951 description: MAC address for the interface
25954 - name: network-name
25956 description: Name of the network
25959 - name: vlan-id-inner
25961 description: Inner VLAN tag
25965 - name: neutron-network-id
25967 description: Neutron network id of the interface that address belongs to
25970 - name: neutron-subnet-id
25972 description: Neutron id of subnet that address belongs to
25978 summary: create or update an existing l3-interface-ipv4-address-list
25980 Create or update an existing l3-interface-ipv4-address-list.
25982 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25983 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25992 description: Response codes found in [response codes](https://wiki.onap.org/).
25994 - name: equipment-name
25998 example: __EQUIPMENT-NAME__
25999 - name: interface-name
26001 description: Name that identifies the physical interface
26004 example: __INTERFACE-NAME__
26005 - name: interface-name
26007 description: Name given to the interface
26010 example: __INTERFACE-NAME__
26011 - name: l3-interface-ipv4-address
26013 description: IP address
26016 example: __L3-INTERFACE-IPV4-ADDRESS__
26019 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26022 $ref: "#/definitions/l3-interface-ipv4-address-list"
26026 summary: update an existing l3-interface-ipv4-address-list
26028 Update an existing l3-interface-ipv4-address-list
26030 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26031 The PUT operation will entirely replace an existing object.
26032 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26034 Other differences between PUT and PATCH are:
26036 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26037 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26038 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26039 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26048 description: Response codes found in [response codes](https://wiki.onap.org/).
26050 - name: equipment-name
26054 example: __EQUIPMENT-NAME__
26055 - name: interface-name
26057 description: Name that identifies the physical interface
26060 example: __INTERFACE-NAME__
26061 - name: interface-name
26063 description: Name given to the interface
26066 example: __INTERFACE-NAME__
26067 - name: l3-interface-ipv4-address
26069 description: IP address
26072 example: __L3-INTERFACE-IPV4-ADDRESS__
26075 description: l3-interface-ipv4-address-list object that needs to be created or updated.
26078 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26082 summary: delete an existing l3-interface-ipv4-address-list
26083 description: delete an existing l3-interface-ipv4-address-list
26084 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26093 description: Response codes found in [response codes](https://wiki.onap.org/).
26095 - name: equipment-name
26099 example: __EQUIPMENT-NAME__
26100 - name: interface-name
26102 description: Name that identifies the physical interface
26105 example: __INTERFACE-NAME__
26106 - name: interface-name
26108 description: Name given to the interface
26111 example: __INTERFACE-NAME__
26112 - name: l3-interface-ipv4-address
26114 description: IP address
26117 example: __L3-INTERFACE-IPV4-ADDRESS__
26118 - name: resource-version
26120 description: resource-version for concurrency
26123 /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:
26127 summary: see node definition for valid relationships
26128 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26137 description: Response codes found in [response codes](https://wiki.onap.org/).
26139 - name: equipment-name
26143 example: __EQUIPMENT-NAME__
26144 - name: interface-name
26146 description: Name that identifies the physical interface
26149 example: __INTERFACE-NAME__
26150 - name: interface-name
26152 description: Name given to the interface
26155 example: __INTERFACE-NAME__
26156 - name: l3-interface-ipv6-address
26158 description: IP address
26161 example: __L3-INTERFACE-IPV6-ADDRESS__
26164 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26167 $ref: "#/definitions/relationship"
26171 summary: delete an existing relationship
26172 description: delete an existing relationship
26173 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26182 description: Response codes found in [response codes](https://wiki.onap.org/).
26184 - name: equipment-name
26188 example: __EQUIPMENT-NAME__
26189 - name: interface-name
26191 description: Name that identifies the physical interface
26194 example: __INTERFACE-NAME__
26195 - name: interface-name
26197 description: Name given to the interface
26200 example: __INTERFACE-NAME__
26201 - name: l3-interface-ipv6-address
26203 description: IP address
26206 example: __L3-INTERFACE-IPV6-ADDRESS__
26207 /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}:
26211 summary: returns l3-interface-ipv6-address-list
26212 description: returns l3-interface-ipv6-address-list
26213 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26219 description: successful operation
26221 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26223 description: Response codes found in [response codes](https://wiki.onap.org/).
26225 - name: equipment-name
26229 example: __EQUIPMENT-NAME__
26230 - name: interface-name
26232 description: Name that identifies the physical interface
26235 example: __INTERFACE-NAME__
26236 - name: interface-name
26238 description: Name given to the interface
26241 example: __INTERFACE-NAME__
26242 - name: l3-interface-ipv6-address
26244 description: IP address
26247 example: __L3-INTERFACE-IPV6-ADDRESS__
26248 - name: prov-status
26250 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26253 - name: prov-status
26255 description: Trigger for operational monitoring of this resource by Service Assurance systems.
26258 - name: interface-id
26260 description: ID of interface
26265 description: MAC address for the interface
26268 - name: network-name
26270 description: Name of the network
26273 - name: vlan-id-inner
26275 description: Inner VLAN tag
26279 - name: neutron-network-id
26281 description: Neutron network id of the interface that address belongs to
26284 - name: neutron-subnet-id
26286 description: Neutron id of subnet that address belongs to
26292 summary: create or update an existing l3-interface-ipv6-address-list
26294 Create or update an existing l3-interface-ipv6-address-list.
26296 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26297 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26306 description: Response codes found in [response codes](https://wiki.onap.org/).
26308 - name: equipment-name
26312 example: __EQUIPMENT-NAME__
26313 - name: interface-name
26315 description: Name that identifies the physical interface
26318 example: __INTERFACE-NAME__
26319 - name: interface-name
26321 description: Name given to the interface
26324 example: __INTERFACE-NAME__
26325 - name: l3-interface-ipv6-address
26327 description: IP address
26330 example: __L3-INTERFACE-IPV6-ADDRESS__
26333 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26336 $ref: "#/definitions/l3-interface-ipv6-address-list"
26340 summary: update an existing l3-interface-ipv6-address-list
26342 Update an existing l3-interface-ipv6-address-list
26344 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26345 The PUT operation will entirely replace an existing object.
26346 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26348 Other differences between PUT and PATCH are:
26350 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26351 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26352 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26353 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26362 description: Response codes found in [response codes](https://wiki.onap.org/).
26364 - name: equipment-name
26368 example: __EQUIPMENT-NAME__
26369 - name: interface-name
26371 description: Name that identifies the physical interface
26374 example: __INTERFACE-NAME__
26375 - name: interface-name
26377 description: Name given to the interface
26380 example: __INTERFACE-NAME__
26381 - name: l3-interface-ipv6-address
26383 description: IP address
26386 example: __L3-INTERFACE-IPV6-ADDRESS__
26389 description: l3-interface-ipv6-address-list object that needs to be created or updated.
26392 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26396 summary: delete an existing l3-interface-ipv6-address-list
26397 description: delete an existing l3-interface-ipv6-address-list
26398 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26407 description: Response codes found in [response codes](https://wiki.onap.org/).
26409 - name: equipment-name
26413 example: __EQUIPMENT-NAME__
26414 - name: interface-name
26416 description: Name that identifies the physical interface
26419 example: __INTERFACE-NAME__
26420 - name: interface-name
26422 description: Name given to the interface
26425 example: __INTERFACE-NAME__
26426 - name: l3-interface-ipv6-address
26428 description: IP address
26431 example: __L3-INTERFACE-IPV6-ADDRESS__
26432 - name: resource-version
26434 description: resource-version for concurrency
26437 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
26441 summary: returns l-interface
26442 description: returns l-interface
26443 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26449 description: successful operation
26451 $ref: "#/getDefinitions/l-interface"
26453 description: Response codes found in [response codes](https://wiki.onap.org/).
26455 - name: equipment-name
26459 example: __EQUIPMENT-NAME__
26460 - name: interface-name
26462 description: Name that identifies the physical interface
26465 example: __INTERFACE-NAME__
26466 - name: interface-name
26468 description: Name given to the interface
26471 example: __INTERFACE-NAME__
26472 - name: prov-status
26474 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26477 - name: prov-status
26479 description: Trigger for operational monitoring of this resource by Service Assurance systems.
26482 - name: interface-id
26484 description: ID of interface
26489 description: MAC address for the interface
26492 - name: network-name
26494 description: Name of the network
26500 summary: create or update an existing l-interface
26502 Create or update an existing l-interface.
26504 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26505 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26514 description: Response codes found in [response codes](https://wiki.onap.org/).
26516 - name: equipment-name
26520 example: __EQUIPMENT-NAME__
26521 - name: interface-name
26523 description: Name that identifies the physical interface
26526 example: __INTERFACE-NAME__
26527 - name: interface-name
26529 description: Name given to the interface
26532 example: __INTERFACE-NAME__
26535 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
26538 $ref: "#/definitions/l-interface"
26542 summary: update an existing l-interface
26544 Update an existing l-interface
26546 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26547 The PUT operation will entirely replace an existing object.
26548 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26550 Other differences between PUT and PATCH are:
26552 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26553 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26554 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26555 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26564 description: Response codes found in [response codes](https://wiki.onap.org/).
26566 - name: equipment-name
26570 example: __EQUIPMENT-NAME__
26571 - name: interface-name
26573 description: Name that identifies the physical interface
26576 example: __INTERFACE-NAME__
26577 - name: interface-name
26579 description: Name given to the interface
26582 example: __INTERFACE-NAME__
26585 description: l-interface object that needs to be created or updated.
26588 $ref: "#/patchDefinitions/l-interface"
26592 summary: delete an existing l-interface
26593 description: delete an existing l-interface
26594 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26603 description: Response codes found in [response codes](https://wiki.onap.org/).
26605 - name: equipment-name
26609 example: __EQUIPMENT-NAME__
26610 - name: interface-name
26612 description: Name that identifies the physical interface
26615 example: __INTERFACE-NAME__
26616 - name: interface-name
26618 description: Name given to the interface
26621 example: __INTERFACE-NAME__
26622 - name: resource-version
26624 description: resource-version for concurrency
26627 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
26631 summary: returns l-interfaces
26632 description: returns l-interfaces
26633 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
26639 description: successful operation
26641 $ref: "#/getDefinitions/l-interfaces"
26643 description: Response codes found in [response codes](https://wiki.onap.org/).
26645 - name: equipment-name
26649 example: __EQUIPMENT-NAME__
26650 - name: interface-name
26652 description: Name that identifies the physical interface
26655 example: __INTERFACE-NAME__
26656 - name: prov-status
26658 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26661 - name: prov-status
26663 description: Trigger for operational monitoring of this resource by Service Assurance systems.
26666 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
26670 summary: returns p-interface
26671 description: returns p-interface
26672 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
26678 description: successful operation
26680 $ref: "#/getDefinitions/p-interface"
26682 description: Response codes found in [response codes](https://wiki.onap.org/).
26684 - name: equipment-name
26688 example: __EQUIPMENT-NAME__
26689 - name: interface-name
26691 description: Name that identifies the physical interface
26694 example: __INTERFACE-NAME__
26695 - name: prov-status
26697 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26700 - name: prov-status
26702 description: Trigger for operational monitoring of this resource by Service Assurance systems.
26708 summary: create or update an existing p-interface
26710 Create or update an existing p-interface.
26712 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26713 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
26722 description: Response codes found in [response codes](https://wiki.onap.org/).
26724 - name: equipment-name
26728 example: __EQUIPMENT-NAME__
26729 - name: interface-name
26731 description: Name that identifies the physical interface
26734 example: __INTERFACE-NAME__
26737 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)
26740 $ref: "#/definitions/p-interface"
26744 summary: update an existing p-interface
26746 Update an existing p-interface
26748 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26749 The PUT operation will entirely replace an existing object.
26750 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26752 Other differences between PUT and PATCH are:
26754 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26755 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26756 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26757 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
26766 description: Response codes found in [response codes](https://wiki.onap.org/).
26768 - name: equipment-name
26772 example: __EQUIPMENT-NAME__
26773 - name: interface-name
26775 description: Name that identifies the physical interface
26778 example: __INTERFACE-NAME__
26781 description: p-interface object that needs to be created or updated.
26784 $ref: "#/patchDefinitions/p-interface"
26788 summary: delete an existing p-interface
26789 description: delete an existing p-interface
26790 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
26799 description: Response codes found in [response codes](https://wiki.onap.org/).
26801 - name: equipment-name
26805 example: __EQUIPMENT-NAME__
26806 - name: interface-name
26808 description: Name that identifies the physical interface
26811 example: __INTERFACE-NAME__
26812 - name: resource-version
26814 description: resource-version for concurrency
26817 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
26821 summary: returns p-interfaces
26822 description: returns p-interfaces
26823 operationId: getNetworkVplsPesVplsPePInterfaces
26829 description: successful operation
26831 $ref: "#/getDefinitions/p-interfaces"
26833 description: Response codes found in [response codes](https://wiki.onap.org/).
26835 - name: equipment-name
26839 example: __EQUIPMENT-NAME__
26840 - name: prov-status
26842 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26845 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
26849 summary: see node definition for valid relationships
26850 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
26859 description: Response codes found in [response codes](https://wiki.onap.org/).
26861 - name: equipment-name
26865 example: __EQUIPMENT-NAME__
26866 - name: interface-name
26868 description: Name that identifies the link aggregate interface
26871 example: __INTERFACE-NAME__
26874 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
26877 $ref: "#/definitions/relationship"
26881 summary: delete an existing relationship
26882 description: delete an existing relationship
26883 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
26892 description: Response codes found in [response codes](https://wiki.onap.org/).
26894 - name: equipment-name
26898 example: __EQUIPMENT-NAME__
26899 - name: interface-name
26901 description: Name that identifies the link aggregate interface
26904 example: __INTERFACE-NAME__
26905 /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:
26909 summary: see node definition for valid relationships
26910 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
26919 description: Response codes found in [response codes](https://wiki.onap.org/).
26921 - name: equipment-name
26925 example: __EQUIPMENT-NAME__
26926 - name: interface-name
26928 description: Name that identifies the link aggregate interface
26931 example: __INTERFACE-NAME__
26932 - name: interface-name
26934 description: Name given to the interface
26937 example: __INTERFACE-NAME__
26938 - name: vlan-interface
26940 description: String that identifies the interface
26943 example: __VLAN-INTERFACE__
26946 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
26949 $ref: "#/definitions/relationship"
26953 summary: delete an existing relationship
26954 description: delete an existing relationship
26955 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
26964 description: Response codes found in [response codes](https://wiki.onap.org/).
26966 - name: equipment-name
26970 example: __EQUIPMENT-NAME__
26971 - name: interface-name
26973 description: Name that identifies the link aggregate interface
26976 example: __INTERFACE-NAME__
26977 - name: interface-name
26979 description: Name given to the interface
26982 example: __INTERFACE-NAME__
26983 - name: vlan-interface
26985 description: String that identifies the interface
26988 example: __VLAN-INTERFACE__
26989 /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:
26993 summary: see node definition for valid relationships
26994 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27003 description: Response codes found in [response codes](https://wiki.onap.org/).
27005 - name: equipment-name
27009 example: __EQUIPMENT-NAME__
27010 - name: interface-name
27012 description: Name that identifies the link aggregate interface
27015 example: __INTERFACE-NAME__
27016 - name: interface-name
27018 description: Name given to the interface
27021 example: __INTERFACE-NAME__
27022 - name: vlan-interface
27024 description: String that identifies the interface
27027 example: __VLAN-INTERFACE__
27028 - name: l3-interface-ipv4-address
27030 description: IP address
27033 example: __L3-INTERFACE-IPV4-ADDRESS__
27036 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27039 $ref: "#/definitions/relationship"
27043 summary: delete an existing relationship
27044 description: delete an existing relationship
27045 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27054 description: Response codes found in [response codes](https://wiki.onap.org/).
27056 - name: equipment-name
27060 example: __EQUIPMENT-NAME__
27061 - name: interface-name
27063 description: Name that identifies the link aggregate interface
27066 example: __INTERFACE-NAME__
27067 - name: interface-name
27069 description: Name given to the interface
27072 example: __INTERFACE-NAME__
27073 - name: vlan-interface
27075 description: String that identifies the interface
27078 example: __VLAN-INTERFACE__
27079 - name: l3-interface-ipv4-address
27081 description: IP address
27084 example: __L3-INTERFACE-IPV4-ADDRESS__
27085 /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}:
27089 summary: returns l3-interface-ipv4-address-list
27090 description: returns l3-interface-ipv4-address-list
27091 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27097 description: successful operation
27099 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27101 description: Response codes found in [response codes](https://wiki.onap.org/).
27103 - name: equipment-name
27107 example: __EQUIPMENT-NAME__
27108 - name: interface-name
27110 description: Name that identifies the link aggregate interface
27113 example: __INTERFACE-NAME__
27114 - name: interface-name
27116 description: Name given to the interface
27119 example: __INTERFACE-NAME__
27120 - name: vlan-interface
27122 description: String that identifies the interface
27125 example: __VLAN-INTERFACE__
27126 - name: l3-interface-ipv4-address
27128 description: IP address
27131 example: __L3-INTERFACE-IPV4-ADDRESS__
27132 - name: prov-status
27134 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27137 - name: interface-id
27139 description: ID of interface
27142 - name: interface-role
27144 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27147 - name: interface-id
27149 description: ID of interface
27154 description: MAC address for the interface
27157 - name: network-name
27159 description: Name of the network
27162 - name: vlan-id-inner
27164 description: Inner VLAN tag
27170 description: This indicates the customers VPN ID associated with this vlan
27173 - name: vlan-id-inner
27175 description: Inner VLAN tag
27179 - name: neutron-network-id
27181 description: Neutron network id of the interface that address belongs to
27184 - name: neutron-subnet-id
27186 description: Neutron id of subnet that address belongs to
27192 summary: create or update an existing l3-interface-ipv4-address-list
27194 Create or update an existing l3-interface-ipv4-address-list.
27196 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27197 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27206 description: Response codes found in [response codes](https://wiki.onap.org/).
27208 - name: equipment-name
27212 example: __EQUIPMENT-NAME__
27213 - name: interface-name
27215 description: Name that identifies the link aggregate interface
27218 example: __INTERFACE-NAME__
27219 - name: interface-name
27221 description: Name given to the interface
27224 example: __INTERFACE-NAME__
27225 - name: vlan-interface
27227 description: String that identifies the interface
27230 example: __VLAN-INTERFACE__
27231 - name: l3-interface-ipv4-address
27233 description: IP address
27236 example: __L3-INTERFACE-IPV4-ADDRESS__
27239 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27242 $ref: "#/definitions/l3-interface-ipv4-address-list"
27246 summary: update an existing l3-interface-ipv4-address-list
27248 Update an existing l3-interface-ipv4-address-list
27250 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27251 The PUT operation will entirely replace an existing object.
27252 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27254 Other differences between PUT and PATCH are:
27256 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27257 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27258 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27259 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27268 description: Response codes found in [response codes](https://wiki.onap.org/).
27270 - name: equipment-name
27274 example: __EQUIPMENT-NAME__
27275 - name: interface-name
27277 description: Name that identifies the link aggregate interface
27280 example: __INTERFACE-NAME__
27281 - name: interface-name
27283 description: Name given to the interface
27286 example: __INTERFACE-NAME__
27287 - name: vlan-interface
27289 description: String that identifies the interface
27292 example: __VLAN-INTERFACE__
27293 - name: l3-interface-ipv4-address
27295 description: IP address
27298 example: __L3-INTERFACE-IPV4-ADDRESS__
27301 description: l3-interface-ipv4-address-list object that needs to be created or updated.
27304 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27308 summary: delete an existing l3-interface-ipv4-address-list
27309 description: delete an existing l3-interface-ipv4-address-list
27310 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27319 description: Response codes found in [response codes](https://wiki.onap.org/).
27321 - name: equipment-name
27325 example: __EQUIPMENT-NAME__
27326 - name: interface-name
27328 description: Name that identifies the link aggregate interface
27331 example: __INTERFACE-NAME__
27332 - name: interface-name
27334 description: Name given to the interface
27337 example: __INTERFACE-NAME__
27338 - name: vlan-interface
27340 description: String that identifies the interface
27343 example: __VLAN-INTERFACE__
27344 - name: l3-interface-ipv4-address
27346 description: IP address
27349 example: __L3-INTERFACE-IPV4-ADDRESS__
27350 - name: resource-version
27352 description: resource-version for concurrency
27355 /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:
27359 summary: see node definition for valid relationships
27360 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27369 description: Response codes found in [response codes](https://wiki.onap.org/).
27371 - name: equipment-name
27375 example: __EQUIPMENT-NAME__
27376 - name: interface-name
27378 description: Name that identifies the link aggregate interface
27381 example: __INTERFACE-NAME__
27382 - name: interface-name
27384 description: Name given to the interface
27387 example: __INTERFACE-NAME__
27388 - name: vlan-interface
27390 description: String that identifies the interface
27393 example: __VLAN-INTERFACE__
27394 - name: l3-interface-ipv6-address
27396 description: IP address
27399 example: __L3-INTERFACE-IPV6-ADDRESS__
27402 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27405 $ref: "#/definitions/relationship"
27409 summary: delete an existing relationship
27410 description: delete an existing relationship
27411 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27420 description: Response codes found in [response codes](https://wiki.onap.org/).
27422 - name: equipment-name
27426 example: __EQUIPMENT-NAME__
27427 - name: interface-name
27429 description: Name that identifies the link aggregate interface
27432 example: __INTERFACE-NAME__
27433 - name: interface-name
27435 description: Name given to the interface
27438 example: __INTERFACE-NAME__
27439 - name: vlan-interface
27441 description: String that identifies the interface
27444 example: __VLAN-INTERFACE__
27445 - name: l3-interface-ipv6-address
27447 description: IP address
27450 example: __L3-INTERFACE-IPV6-ADDRESS__
27451 /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}:
27455 summary: returns l3-interface-ipv6-address-list
27456 description: returns l3-interface-ipv6-address-list
27457 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27463 description: successful operation
27465 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27467 description: Response codes found in [response codes](https://wiki.onap.org/).
27469 - name: equipment-name
27473 example: __EQUIPMENT-NAME__
27474 - name: interface-name
27476 description: Name that identifies the link aggregate interface
27479 example: __INTERFACE-NAME__
27480 - name: interface-name
27482 description: Name given to the interface
27485 example: __INTERFACE-NAME__
27486 - name: vlan-interface
27488 description: String that identifies the interface
27491 example: __VLAN-INTERFACE__
27492 - name: l3-interface-ipv6-address
27494 description: IP address
27497 example: __L3-INTERFACE-IPV6-ADDRESS__
27498 - name: prov-status
27500 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27503 - name: interface-id
27505 description: ID of interface
27508 - name: interface-role
27510 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27513 - name: interface-id
27515 description: ID of interface
27520 description: MAC address for the interface
27523 - name: network-name
27525 description: Name of the network
27528 - name: vlan-id-inner
27530 description: Inner VLAN tag
27536 description: This indicates the customers VPN ID associated with this vlan
27539 - name: vlan-id-inner
27541 description: Inner VLAN tag
27545 - name: neutron-network-id
27547 description: Neutron network id of the interface that address belongs to
27550 - name: neutron-subnet-id
27552 description: Neutron id of subnet that address belongs to
27558 summary: create or update an existing l3-interface-ipv6-address-list
27560 Create or update an existing l3-interface-ipv6-address-list.
27562 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27563 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27572 description: Response codes found in [response codes](https://wiki.onap.org/).
27574 - name: equipment-name
27578 example: __EQUIPMENT-NAME__
27579 - name: interface-name
27581 description: Name that identifies the link aggregate interface
27584 example: __INTERFACE-NAME__
27585 - name: interface-name
27587 description: Name given to the interface
27590 example: __INTERFACE-NAME__
27591 - name: vlan-interface
27593 description: String that identifies the interface
27596 example: __VLAN-INTERFACE__
27597 - name: l3-interface-ipv6-address
27599 description: IP address
27602 example: __L3-INTERFACE-IPV6-ADDRESS__
27605 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27608 $ref: "#/definitions/l3-interface-ipv6-address-list"
27612 summary: update an existing l3-interface-ipv6-address-list
27614 Update an existing l3-interface-ipv6-address-list
27616 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27617 The PUT operation will entirely replace an existing object.
27618 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27620 Other differences between PUT and PATCH are:
27622 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27623 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27624 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27625 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27634 description: Response codes found in [response codes](https://wiki.onap.org/).
27636 - name: equipment-name
27640 example: __EQUIPMENT-NAME__
27641 - name: interface-name
27643 description: Name that identifies the link aggregate interface
27646 example: __INTERFACE-NAME__
27647 - name: interface-name
27649 description: Name given to the interface
27652 example: __INTERFACE-NAME__
27653 - name: vlan-interface
27655 description: String that identifies the interface
27658 example: __VLAN-INTERFACE__
27659 - name: l3-interface-ipv6-address
27661 description: IP address
27664 example: __L3-INTERFACE-IPV6-ADDRESS__
27667 description: l3-interface-ipv6-address-list object that needs to be created or updated.
27670 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27674 summary: delete an existing l3-interface-ipv6-address-list
27675 description: delete an existing l3-interface-ipv6-address-list
27676 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27685 description: Response codes found in [response codes](https://wiki.onap.org/).
27687 - name: equipment-name
27691 example: __EQUIPMENT-NAME__
27692 - name: interface-name
27694 description: Name that identifies the link aggregate interface
27697 example: __INTERFACE-NAME__
27698 - name: interface-name
27700 description: Name given to the interface
27703 example: __INTERFACE-NAME__
27704 - name: vlan-interface
27706 description: String that identifies the interface
27709 example: __VLAN-INTERFACE__
27710 - name: l3-interface-ipv6-address
27712 description: IP address
27715 example: __L3-INTERFACE-IPV6-ADDRESS__
27716 - name: resource-version
27718 description: resource-version for concurrency
27721 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
27725 summary: returns vlan
27726 description: returns vlan
27727 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27733 description: successful operation
27735 $ref: "#/getDefinitions/vlan"
27737 description: Response codes found in [response codes](https://wiki.onap.org/).
27739 - name: equipment-name
27743 example: __EQUIPMENT-NAME__
27744 - name: interface-name
27746 description: Name that identifies the link aggregate interface
27749 example: __INTERFACE-NAME__
27750 - name: interface-name
27752 description: Name given to the interface
27755 example: __INTERFACE-NAME__
27756 - name: vlan-interface
27758 description: String that identifies the interface
27761 example: __VLAN-INTERFACE__
27762 - name: prov-status
27764 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27767 - name: interface-id
27769 description: ID of interface
27772 - name: interface-role
27774 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27777 - name: interface-id
27779 description: ID of interface
27784 description: MAC address for the interface
27787 - name: network-name
27789 description: Name of the network
27792 - name: vlan-id-inner
27794 description: Inner VLAN tag
27800 description: This indicates the customers VPN ID associated with this vlan
27806 summary: create or update an existing vlan
27808 Create or update an existing vlan.
27810 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27811 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27820 description: Response codes found in [response codes](https://wiki.onap.org/).
27822 - name: equipment-name
27826 example: __EQUIPMENT-NAME__
27827 - name: interface-name
27829 description: Name that identifies the link aggregate interface
27832 example: __INTERFACE-NAME__
27833 - name: interface-name
27835 description: Name given to the interface
27838 example: __INTERFACE-NAME__
27839 - name: vlan-interface
27841 description: String that identifies the interface
27844 example: __VLAN-INTERFACE__
27847 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
27850 $ref: "#/definitions/vlan"
27854 summary: update an existing vlan
27856 Update an existing vlan
27858 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27859 The PUT operation will entirely replace an existing object.
27860 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27862 Other differences between PUT and PATCH are:
27864 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27865 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27866 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27867 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27876 description: Response codes found in [response codes](https://wiki.onap.org/).
27878 - name: equipment-name
27882 example: __EQUIPMENT-NAME__
27883 - name: interface-name
27885 description: Name that identifies the link aggregate interface
27888 example: __INTERFACE-NAME__
27889 - name: interface-name
27891 description: Name given to the interface
27894 example: __INTERFACE-NAME__
27895 - name: vlan-interface
27897 description: String that identifies the interface
27900 example: __VLAN-INTERFACE__
27903 description: vlan object that needs to be created or updated.
27906 $ref: "#/patchDefinitions/vlan"
27910 summary: delete an existing vlan
27911 description: delete an existing vlan
27912 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27921 description: Response codes found in [response codes](https://wiki.onap.org/).
27923 - name: equipment-name
27927 example: __EQUIPMENT-NAME__
27928 - name: interface-name
27930 description: Name that identifies the link aggregate interface
27933 example: __INTERFACE-NAME__
27934 - name: interface-name
27936 description: Name given to the interface
27939 example: __INTERFACE-NAME__
27940 - name: vlan-interface
27942 description: String that identifies the interface
27945 example: __VLAN-INTERFACE__
27946 - name: resource-version
27948 description: resource-version for concurrency
27951 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
27955 summary: returns vlans
27956 description: returns vlans
27957 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
27963 description: successful operation
27965 $ref: "#/getDefinitions/vlans"
27967 description: Response codes found in [response codes](https://wiki.onap.org/).
27969 - name: equipment-name
27973 example: __EQUIPMENT-NAME__
27974 - name: interface-name
27976 description: Name that identifies the link aggregate interface
27979 example: __INTERFACE-NAME__
27980 - name: interface-name
27982 description: Name given to the interface
27985 example: __INTERFACE-NAME__
27986 - name: prov-status
27988 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27991 - name: interface-id
27993 description: ID of interface
27996 - name: interface-role
27998 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28001 - name: interface-id
28003 description: ID of interface
28008 description: MAC address for the interface
28011 - name: network-name
28013 description: Name of the network
28016 /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:
28020 summary: see node definition for valid relationships
28021 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28030 description: Response codes found in [response codes](https://wiki.onap.org/).
28032 - name: equipment-name
28036 example: __EQUIPMENT-NAME__
28037 - name: interface-name
28039 description: Name that identifies the link aggregate interface
28042 example: __INTERFACE-NAME__
28043 - name: interface-name
28045 description: Name given to the interface
28048 example: __INTERFACE-NAME__
28051 description: PCI ID used to identify the sriov-vf
28054 example: __PCI-ID__
28057 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28060 $ref: "#/definitions/relationship"
28064 summary: delete an existing relationship
28065 description: delete an existing relationship
28066 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28075 description: Response codes found in [response codes](https://wiki.onap.org/).
28077 - name: equipment-name
28081 example: __EQUIPMENT-NAME__
28082 - name: interface-name
28084 description: Name that identifies the link aggregate interface
28087 example: __INTERFACE-NAME__
28088 - name: interface-name
28090 description: Name given to the interface
28093 example: __INTERFACE-NAME__
28096 description: PCI ID used to identify the sriov-vf
28099 example: __PCI-ID__
28100 /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}:
28104 summary: returns sriov-vf
28105 description: returns sriov-vf
28106 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28112 description: successful operation
28114 $ref: "#/getDefinitions/sriov-vf"
28116 description: Response codes found in [response codes](https://wiki.onap.org/).
28118 - name: equipment-name
28122 example: __EQUIPMENT-NAME__
28123 - name: interface-name
28125 description: Name that identifies the link aggregate interface
28128 example: __INTERFACE-NAME__
28129 - name: interface-name
28131 description: Name given to the interface
28134 example: __INTERFACE-NAME__
28137 description: PCI ID used to identify the sriov-vf
28140 example: __PCI-ID__
28141 - name: prov-status
28143 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28146 - name: interface-id
28148 description: ID of interface
28151 - name: interface-role
28153 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28156 - name: interface-id
28158 description: ID of interface
28163 description: MAC address for the interface
28166 - name: network-name
28168 description: Name of the network
28171 - name: vf-vlan-filter
28173 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
28176 - name: vf-mac-filter
28178 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
28181 - name: vf-vlan-strip
28183 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
28186 - name: neutron-network-id
28188 description: Neutron network id of the interface
28194 summary: create or update an existing sriov-vf
28196 Create or update an existing sriov-vf.
28198 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28199 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28208 description: Response codes found in [response codes](https://wiki.onap.org/).
28210 - name: equipment-name
28214 example: __EQUIPMENT-NAME__
28215 - name: interface-name
28217 description: Name that identifies the link aggregate interface
28220 example: __INTERFACE-NAME__
28221 - name: interface-name
28223 description: Name given to the interface
28226 example: __INTERFACE-NAME__
28229 description: PCI ID used to identify the sriov-vf
28232 example: __PCI-ID__
28235 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28238 $ref: "#/definitions/sriov-vf"
28242 summary: update an existing sriov-vf
28244 Update an existing sriov-vf
28246 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28247 The PUT operation will entirely replace an existing object.
28248 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28250 Other differences between PUT and PATCH are:
28252 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28253 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28254 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28255 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28264 description: Response codes found in [response codes](https://wiki.onap.org/).
28266 - name: equipment-name
28270 example: __EQUIPMENT-NAME__
28271 - name: interface-name
28273 description: Name that identifies the link aggregate interface
28276 example: __INTERFACE-NAME__
28277 - name: interface-name
28279 description: Name given to the interface
28282 example: __INTERFACE-NAME__
28285 description: PCI ID used to identify the sriov-vf
28288 example: __PCI-ID__
28291 description: sriov-vf object that needs to be created or updated.
28294 $ref: "#/patchDefinitions/sriov-vf"
28298 summary: delete an existing sriov-vf
28299 description: delete an existing sriov-vf
28300 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28309 description: Response codes found in [response codes](https://wiki.onap.org/).
28311 - name: equipment-name
28315 example: __EQUIPMENT-NAME__
28316 - name: interface-name
28318 description: Name that identifies the link aggregate interface
28321 example: __INTERFACE-NAME__
28322 - name: interface-name
28324 description: Name given to the interface
28327 example: __INTERFACE-NAME__
28330 description: PCI ID used to identify the sriov-vf
28333 example: __PCI-ID__
28334 - name: resource-version
28336 description: resource-version for concurrency
28339 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
28343 summary: returns sriov-vfs
28344 description: returns sriov-vfs
28345 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
28351 description: successful operation
28353 $ref: "#/getDefinitions/sriov-vfs"
28355 description: Response codes found in [response codes](https://wiki.onap.org/).
28357 - name: equipment-name
28361 example: __EQUIPMENT-NAME__
28362 - name: interface-name
28364 description: Name that identifies the link aggregate interface
28367 example: __INTERFACE-NAME__
28368 - name: interface-name
28370 description: Name given to the interface
28373 example: __INTERFACE-NAME__
28374 - name: prov-status
28376 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28379 - name: interface-id
28381 description: ID of interface
28384 - name: interface-role
28386 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28389 - name: interface-id
28391 description: ID of interface
28396 description: MAC address for the interface
28399 - name: network-name
28401 description: Name of the network
28404 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
28408 summary: see node definition for valid relationships
28409 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28418 description: Response codes found in [response codes](https://wiki.onap.org/).
28420 - name: equipment-name
28424 example: __EQUIPMENT-NAME__
28425 - name: interface-name
28427 description: Name that identifies the link aggregate interface
28430 example: __INTERFACE-NAME__
28431 - name: interface-name
28433 description: Name given to the interface
28436 example: __INTERFACE-NAME__
28439 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
28442 $ref: "#/definitions/relationship"
28446 summary: delete an existing relationship
28447 description: delete an existing relationship
28448 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28457 description: Response codes found in [response codes](https://wiki.onap.org/).
28459 - name: equipment-name
28463 example: __EQUIPMENT-NAME__
28464 - name: interface-name
28466 description: Name that identifies the link aggregate interface
28469 example: __INTERFACE-NAME__
28470 - name: interface-name
28472 description: Name given to the interface
28475 example: __INTERFACE-NAME__
28476 /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:
28480 summary: see node definition for valid relationships
28481 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28490 description: Response codes found in [response codes](https://wiki.onap.org/).
28492 - name: equipment-name
28496 example: __EQUIPMENT-NAME__
28497 - name: interface-name
28499 description: Name that identifies the link aggregate interface
28502 example: __INTERFACE-NAME__
28503 - name: interface-name
28505 description: Name given to the interface
28508 example: __INTERFACE-NAME__
28509 - name: l3-interface-ipv4-address
28511 description: IP address
28514 example: __L3-INTERFACE-IPV4-ADDRESS__
28517 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28520 $ref: "#/definitions/relationship"
28524 summary: delete an existing relationship
28525 description: delete an existing relationship
28526 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28535 description: Response codes found in [response codes](https://wiki.onap.org/).
28537 - name: equipment-name
28541 example: __EQUIPMENT-NAME__
28542 - name: interface-name
28544 description: Name that identifies the link aggregate interface
28547 example: __INTERFACE-NAME__
28548 - name: interface-name
28550 description: Name given to the interface
28553 example: __INTERFACE-NAME__
28554 - name: l3-interface-ipv4-address
28556 description: IP address
28559 example: __L3-INTERFACE-IPV4-ADDRESS__
28560 /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}:
28564 summary: returns l3-interface-ipv4-address-list
28565 description: returns l3-interface-ipv4-address-list
28566 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28572 description: successful operation
28574 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28576 description: Response codes found in [response codes](https://wiki.onap.org/).
28578 - name: equipment-name
28582 example: __EQUIPMENT-NAME__
28583 - name: interface-name
28585 description: Name that identifies the link aggregate interface
28588 example: __INTERFACE-NAME__
28589 - name: interface-name
28591 description: Name given to the interface
28594 example: __INTERFACE-NAME__
28595 - name: l3-interface-ipv4-address
28597 description: IP address
28600 example: __L3-INTERFACE-IPV4-ADDRESS__
28601 - name: prov-status
28603 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28606 - name: interface-id
28608 description: ID of interface
28611 - name: interface-role
28613 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28616 - name: interface-id
28618 description: ID of interface
28623 description: MAC address for the interface
28626 - name: network-name
28628 description: Name of the network
28631 - name: vlan-id-inner
28633 description: Inner VLAN tag
28637 - name: neutron-network-id
28639 description: Neutron network id of the interface that address belongs to
28642 - name: neutron-subnet-id
28644 description: Neutron id of subnet that address belongs to
28650 summary: create or update an existing l3-interface-ipv4-address-list
28652 Create or update an existing l3-interface-ipv4-address-list.
28654 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28655 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28664 description: Response codes found in [response codes](https://wiki.onap.org/).
28666 - name: equipment-name
28670 example: __EQUIPMENT-NAME__
28671 - name: interface-name
28673 description: Name that identifies the link aggregate interface
28676 example: __INTERFACE-NAME__
28677 - name: interface-name
28679 description: Name given to the interface
28682 example: __INTERFACE-NAME__
28683 - name: l3-interface-ipv4-address
28685 description: IP address
28688 example: __L3-INTERFACE-IPV4-ADDRESS__
28691 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28694 $ref: "#/definitions/l3-interface-ipv4-address-list"
28698 summary: update an existing l3-interface-ipv4-address-list
28700 Update an existing l3-interface-ipv4-address-list
28702 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28703 The PUT operation will entirely replace an existing object.
28704 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28706 Other differences between PUT and PATCH are:
28708 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28709 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28710 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28711 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28720 description: Response codes found in [response codes](https://wiki.onap.org/).
28722 - name: equipment-name
28726 example: __EQUIPMENT-NAME__
28727 - name: interface-name
28729 description: Name that identifies the link aggregate interface
28732 example: __INTERFACE-NAME__
28733 - name: interface-name
28735 description: Name given to the interface
28738 example: __INTERFACE-NAME__
28739 - name: l3-interface-ipv4-address
28741 description: IP address
28744 example: __L3-INTERFACE-IPV4-ADDRESS__
28747 description: l3-interface-ipv4-address-list object that needs to be created or updated.
28750 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28754 summary: delete an existing l3-interface-ipv4-address-list
28755 description: delete an existing l3-interface-ipv4-address-list
28756 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28765 description: Response codes found in [response codes](https://wiki.onap.org/).
28767 - name: equipment-name
28771 example: __EQUIPMENT-NAME__
28772 - name: interface-name
28774 description: Name that identifies the link aggregate interface
28777 example: __INTERFACE-NAME__
28778 - name: interface-name
28780 description: Name given to the interface
28783 example: __INTERFACE-NAME__
28784 - name: l3-interface-ipv4-address
28786 description: IP address
28789 example: __L3-INTERFACE-IPV4-ADDRESS__
28790 - name: resource-version
28792 description: resource-version for concurrency
28795 /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:
28799 summary: see node definition for valid relationships
28800 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28809 description: Response codes found in [response codes](https://wiki.onap.org/).
28811 - name: equipment-name
28815 example: __EQUIPMENT-NAME__
28816 - name: interface-name
28818 description: Name that identifies the link aggregate interface
28821 example: __INTERFACE-NAME__
28822 - name: interface-name
28824 description: Name given to the interface
28827 example: __INTERFACE-NAME__
28828 - name: l3-interface-ipv6-address
28830 description: IP address
28833 example: __L3-INTERFACE-IPV6-ADDRESS__
28836 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28839 $ref: "#/definitions/relationship"
28843 summary: delete an existing relationship
28844 description: delete an existing relationship
28845 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28854 description: Response codes found in [response codes](https://wiki.onap.org/).
28856 - name: equipment-name
28860 example: __EQUIPMENT-NAME__
28861 - name: interface-name
28863 description: Name that identifies the link aggregate interface
28866 example: __INTERFACE-NAME__
28867 - name: interface-name
28869 description: Name given to the interface
28872 example: __INTERFACE-NAME__
28873 - name: l3-interface-ipv6-address
28875 description: IP address
28878 example: __L3-INTERFACE-IPV6-ADDRESS__
28879 /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}:
28883 summary: returns l3-interface-ipv6-address-list
28884 description: returns l3-interface-ipv6-address-list
28885 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
28891 description: successful operation
28893 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28895 description: Response codes found in [response codes](https://wiki.onap.org/).
28897 - name: equipment-name
28901 example: __EQUIPMENT-NAME__
28902 - name: interface-name
28904 description: Name that identifies the link aggregate interface
28907 example: __INTERFACE-NAME__
28908 - name: interface-name
28910 description: Name given to the interface
28913 example: __INTERFACE-NAME__
28914 - name: l3-interface-ipv6-address
28916 description: IP address
28919 example: __L3-INTERFACE-IPV6-ADDRESS__
28920 - name: prov-status
28922 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28925 - name: interface-id
28927 description: ID of interface
28930 - name: interface-role
28932 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28935 - name: interface-id
28937 description: ID of interface
28942 description: MAC address for the interface
28945 - name: network-name
28947 description: Name of the network
28950 - name: vlan-id-inner
28952 description: Inner VLAN tag
28956 - name: neutron-network-id
28958 description: Neutron network id of the interface that address belongs to
28961 - name: neutron-subnet-id
28963 description: Neutron id of subnet that address belongs to
28969 summary: create or update an existing l3-interface-ipv6-address-list
28971 Create or update an existing l3-interface-ipv6-address-list.
28973 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28974 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
28983 description: Response codes found in [response codes](https://wiki.onap.org/).
28985 - name: equipment-name
28989 example: __EQUIPMENT-NAME__
28990 - name: interface-name
28992 description: Name that identifies the link aggregate interface
28995 example: __INTERFACE-NAME__
28996 - name: interface-name
28998 description: Name given to the interface
29001 example: __INTERFACE-NAME__
29002 - name: l3-interface-ipv6-address
29004 description: IP address
29007 example: __L3-INTERFACE-IPV6-ADDRESS__
29010 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
29013 $ref: "#/definitions/l3-interface-ipv6-address-list"
29017 summary: update an existing l3-interface-ipv6-address-list
29019 Update an existing l3-interface-ipv6-address-list
29021 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29022 The PUT operation will entirely replace an existing object.
29023 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29025 Other differences between PUT and PATCH are:
29027 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29028 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29029 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29030 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29039 description: Response codes found in [response codes](https://wiki.onap.org/).
29041 - name: equipment-name
29045 example: __EQUIPMENT-NAME__
29046 - name: interface-name
29048 description: Name that identifies the link aggregate interface
29051 example: __INTERFACE-NAME__
29052 - name: interface-name
29054 description: Name given to the interface
29057 example: __INTERFACE-NAME__
29058 - name: l3-interface-ipv6-address
29060 description: IP address
29063 example: __L3-INTERFACE-IPV6-ADDRESS__
29066 description: l3-interface-ipv6-address-list object that needs to be created or updated.
29069 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29073 summary: delete an existing l3-interface-ipv6-address-list
29074 description: delete an existing l3-interface-ipv6-address-list
29075 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29084 description: Response codes found in [response codes](https://wiki.onap.org/).
29086 - name: equipment-name
29090 example: __EQUIPMENT-NAME__
29091 - name: interface-name
29093 description: Name that identifies the link aggregate interface
29096 example: __INTERFACE-NAME__
29097 - name: interface-name
29099 description: Name given to the interface
29102 example: __INTERFACE-NAME__
29103 - name: l3-interface-ipv6-address
29105 description: IP address
29108 example: __L3-INTERFACE-IPV6-ADDRESS__
29109 - name: resource-version
29111 description: resource-version for concurrency
29114 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
29118 summary: returns l-interface
29119 description: returns l-interface
29120 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29126 description: successful operation
29128 $ref: "#/getDefinitions/l-interface"
29130 description: Response codes found in [response codes](https://wiki.onap.org/).
29132 - name: equipment-name
29136 example: __EQUIPMENT-NAME__
29137 - name: interface-name
29139 description: Name that identifies the link aggregate interface
29142 example: __INTERFACE-NAME__
29143 - name: interface-name
29145 description: Name given to the interface
29148 example: __INTERFACE-NAME__
29149 - name: prov-status
29151 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29154 - name: interface-id
29156 description: ID of interface
29159 - name: interface-role
29161 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29164 - name: interface-id
29166 description: ID of interface
29171 description: MAC address for the interface
29174 - name: network-name
29176 description: Name of the network
29182 summary: create or update an existing l-interface
29184 Create or update an existing l-interface.
29186 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29187 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29196 description: Response codes found in [response codes](https://wiki.onap.org/).
29198 - name: equipment-name
29202 example: __EQUIPMENT-NAME__
29203 - name: interface-name
29205 description: Name that identifies the link aggregate interface
29208 example: __INTERFACE-NAME__
29209 - name: interface-name
29211 description: Name given to the interface
29214 example: __INTERFACE-NAME__
29217 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
29220 $ref: "#/definitions/l-interface"
29224 summary: update an existing l-interface
29226 Update an existing l-interface
29228 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29229 The PUT operation will entirely replace an existing object.
29230 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29232 Other differences between PUT and PATCH are:
29234 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29235 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29236 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29237 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29246 description: Response codes found in [response codes](https://wiki.onap.org/).
29248 - name: equipment-name
29252 example: __EQUIPMENT-NAME__
29253 - name: interface-name
29255 description: Name that identifies the link aggregate interface
29258 example: __INTERFACE-NAME__
29259 - name: interface-name
29261 description: Name given to the interface
29264 example: __INTERFACE-NAME__
29267 description: l-interface object that needs to be created or updated.
29270 $ref: "#/patchDefinitions/l-interface"
29274 summary: delete an existing l-interface
29275 description: delete an existing l-interface
29276 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29285 description: Response codes found in [response codes](https://wiki.onap.org/).
29287 - name: equipment-name
29291 example: __EQUIPMENT-NAME__
29292 - name: interface-name
29294 description: Name that identifies the link aggregate interface
29297 example: __INTERFACE-NAME__
29298 - name: interface-name
29300 description: Name given to the interface
29303 example: __INTERFACE-NAME__
29304 - name: resource-version
29306 description: resource-version for concurrency
29309 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
29313 summary: returns l-interfaces
29314 description: returns l-interfaces
29315 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
29321 description: successful operation
29323 $ref: "#/getDefinitions/l-interfaces"
29325 description: Response codes found in [response codes](https://wiki.onap.org/).
29327 - name: equipment-name
29331 example: __EQUIPMENT-NAME__
29332 - name: interface-name
29334 description: Name that identifies the link aggregate interface
29337 example: __INTERFACE-NAME__
29338 - name: prov-status
29340 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29343 - name: interface-id
29345 description: ID of interface
29348 - name: interface-role
29350 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29353 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
29357 summary: returns lag-interface
29358 description: returns lag-interface
29359 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
29365 description: successful operation
29367 $ref: "#/getDefinitions/lag-interface"
29369 description: Response codes found in [response codes](https://wiki.onap.org/).
29371 - name: equipment-name
29375 example: __EQUIPMENT-NAME__
29376 - name: interface-name
29378 description: Name that identifies the link aggregate interface
29381 example: __INTERFACE-NAME__
29382 - name: prov-status
29384 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29387 - name: interface-id
29389 description: ID of interface
29392 - name: interface-role
29394 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29400 summary: create or update an existing lag-interface
29402 Create or update an existing lag-interface.
29404 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29405 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
29414 description: Response codes found in [response codes](https://wiki.onap.org/).
29416 - name: equipment-name
29420 example: __EQUIPMENT-NAME__
29421 - name: interface-name
29423 description: Name that identifies the link aggregate interface
29426 example: __INTERFACE-NAME__
29429 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
29432 $ref: "#/definitions/lag-interface"
29436 summary: update an existing lag-interface
29438 Update an existing lag-interface
29440 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29441 The PUT operation will entirely replace an existing object.
29442 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29444 Other differences between PUT and PATCH are:
29446 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29447 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29448 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29449 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
29458 description: Response codes found in [response codes](https://wiki.onap.org/).
29460 - name: equipment-name
29464 example: __EQUIPMENT-NAME__
29465 - name: interface-name
29467 description: Name that identifies the link aggregate interface
29470 example: __INTERFACE-NAME__
29473 description: lag-interface object that needs to be created or updated.
29476 $ref: "#/patchDefinitions/lag-interface"
29480 summary: delete an existing lag-interface
29481 description: delete an existing lag-interface
29482 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
29491 description: Response codes found in [response codes](https://wiki.onap.org/).
29493 - name: equipment-name
29497 example: __EQUIPMENT-NAME__
29498 - name: interface-name
29500 description: Name that identifies the link aggregate interface
29503 example: __INTERFACE-NAME__
29504 - name: resource-version
29506 description: resource-version for concurrency
29509 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
29513 summary: returns lag-interfaces
29514 description: returns lag-interfaces
29515 operationId: getNetworkVplsPesVplsPeLagInterfaces
29521 description: successful operation
29523 $ref: "#/getDefinitions/lag-interfaces"
29525 description: Response codes found in [response codes](https://wiki.onap.org/).
29527 - name: equipment-name
29531 example: __EQUIPMENT-NAME__
29532 - name: prov-status
29534 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29537 /network/vpls-pes/vpls-pe/{equipment-name}:
29541 summary: returns vpls-pe
29542 description: returns vpls-pe
29543 operationId: getNetworkVplsPesVplsPe
29549 description: successful operation
29551 $ref: "#/getDefinitions/vpls-pe"
29553 description: Response codes found in [response codes](https://wiki.onap.org/).
29555 - name: equipment-name
29559 example: __EQUIPMENT-NAME__
29560 - name: prov-status
29562 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29568 summary: create or update an existing vpls-pe
29570 Create or update an existing vpls-pe.
29572 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29573 operationId: createOrUpdateNetworkVplsPesVplsPe
29582 description: Response codes found in [response codes](https://wiki.onap.org/).
29584 - name: equipment-name
29588 example: __EQUIPMENT-NAME__
29591 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)
29594 $ref: "#/definitions/vpls-pe"
29598 summary: update an existing vpls-pe
29600 Update an existing vpls-pe
29602 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29603 The PUT operation will entirely replace an existing object.
29604 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29606 Other differences between PUT and PATCH are:
29608 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29609 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29610 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29611 operationId: UpdateNetworkVplsPesVplsPe
29620 description: Response codes found in [response codes](https://wiki.onap.org/).
29622 - name: equipment-name
29626 example: __EQUIPMENT-NAME__
29629 description: vpls-pe object that needs to be created or updated.
29632 $ref: "#/patchDefinitions/vpls-pe"
29636 summary: delete an existing vpls-pe
29637 description: delete an existing vpls-pe
29638 operationId: deleteNetworkVplsPesVplsPe
29647 description: Response codes found in [response codes](https://wiki.onap.org/).
29649 - name: equipment-name
29653 example: __EQUIPMENT-NAME__
29654 - name: resource-version
29656 description: resource-version for concurrency
29663 summary: returns vpls-pes
29664 description: returns vpls-pes
29665 operationId: getNetworkVplsPes
29671 description: successful operation
29673 $ref: "#/getDefinitions/vpls-pes"
29675 description: Response codes found in [response codes](https://wiki.onap.org/).
29676 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
29680 summary: see node definition for valid relationships
29681 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
29690 description: Response codes found in [response codes](https://wiki.onap.org/).
29692 - name: multicast-configuration-id
29694 description: Unique id of multicast configuration.
29697 example: __MULTICAST-CONFIGURATION-ID__
29700 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)
29703 $ref: "#/definitions/relationship"
29707 summary: delete an existing relationship
29708 description: delete an existing relationship
29709 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
29718 description: Response codes found in [response codes](https://wiki.onap.org/).
29720 - name: multicast-configuration-id
29722 description: Unique id of multicast configuration.
29725 example: __MULTICAST-CONFIGURATION-ID__
29726 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
29730 summary: returns multicast-configuration
29731 description: returns multicast-configuration
29732 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
29738 description: successful operation
29740 $ref: "#/getDefinitions/multicast-configuration"
29742 description: Response codes found in [response codes](https://wiki.onap.org/).
29744 - name: multicast-configuration-id
29746 description: Unique id of multicast configuration.
29749 example: __MULTICAST-CONFIGURATION-ID__
29753 summary: create or update an existing multicast-configuration
29755 Create or update an existing multicast-configuration.
29757 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29758 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
29767 description: Response codes found in [response codes](https://wiki.onap.org/).
29769 - name: multicast-configuration-id
29771 description: Unique id of multicast configuration.
29774 example: __MULTICAST-CONFIGURATION-ID__
29777 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)
29780 $ref: "#/definitions/multicast-configuration"
29784 summary: update an existing multicast-configuration
29786 Update an existing multicast-configuration
29788 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29789 The PUT operation will entirely replace an existing object.
29790 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29792 Other differences between PUT and PATCH are:
29794 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29795 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29796 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29797 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
29806 description: Response codes found in [response codes](https://wiki.onap.org/).
29808 - name: multicast-configuration-id
29810 description: Unique id of multicast configuration.
29813 example: __MULTICAST-CONFIGURATION-ID__
29816 description: multicast-configuration object that needs to be created or updated.
29819 $ref: "#/patchDefinitions/multicast-configuration"
29823 summary: delete an existing multicast-configuration
29824 description: delete an existing multicast-configuration
29825 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
29834 description: Response codes found in [response codes](https://wiki.onap.org/).
29836 - name: multicast-configuration-id
29838 description: Unique id of multicast configuration.
29841 example: __MULTICAST-CONFIGURATION-ID__
29842 - name: resource-version
29844 description: resource-version for concurrency
29847 /network/multicast-configurations:
29851 summary: returns multicast-configurations
29852 description: returns multicast-configurations
29853 operationId: getNetworkMulticastConfigurations
29859 description: successful operation
29861 $ref: "#/getDefinitions/multicast-configurations"
29863 description: Response codes found in [response codes](https://wiki.onap.org/).
29864 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
29868 summary: see node definition for valid relationships
29869 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
29878 description: Response codes found in [response codes](https://wiki.onap.org/).
29882 description: Unique id of VNF. This is unique across the graph.
29885 example: __VNF-ID__
29886 - name: interface-id
29888 description: Unique ID of the interface
29891 example: __INTERFACE-ID__
29894 description: See mis-na-virtualization-platform.yang
29898 example: __CVLAN-TAG__
29901 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
29904 $ref: "#/definitions/relationship"
29908 summary: delete an existing relationship
29909 description: delete an existing relationship
29910 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
29919 description: Response codes found in [response codes](https://wiki.onap.org/).
29923 description: Unique id of VNF. This is unique across the graph.
29926 example: __VNF-ID__
29927 - name: interface-id
29929 description: Unique ID of the interface
29932 example: __INTERFACE-ID__
29935 description: See mis-na-virtualization-platform.yang
29939 example: __CVLAN-TAG__
29940 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
29944 summary: returns cvlan-tag-entry
29945 description: returns cvlan-tag-entry
29946 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
29952 description: successful operation
29954 $ref: "#/getDefinitions/cvlan-tag-entry"
29956 description: Response codes found in [response codes](https://wiki.onap.org/).
29960 description: Unique id of VNF. This is unique across the graph.
29963 example: __VNF-ID__
29964 - name: interface-id
29966 description: Unique ID of the interface
29969 example: __INTERFACE-ID__
29972 description: See mis-na-virtualization-platform.yang
29976 example: __CVLAN-TAG__
29979 description: Name of VNF.
29984 description: Alternate name of VNF.
29989 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.
29994 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
29997 - name: regional-resource-zone
29999 description: Regional way of organizing pservers, source of truth should define values
30002 - name: prov-status
30004 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30007 - name: heat-stack-id
30009 description: Heat stack id corresponding to this instance, managed by MSO
30014 description: Unique ID of VPE connected to this VCE.
30017 - name: port-group-id
30019 description: Unique ID for port group in vmware
30022 - name: switch-name
30024 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
30027 - name: heat-stack-id
30029 description: Heat stack id corresponding to this instance, managed by MSO
30035 summary: create or update an existing cvlan-tag-entry
30037 Create or update an existing cvlan-tag-entry.
30039 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30040 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30049 description: Response codes found in [response codes](https://wiki.onap.org/).
30053 description: Unique id of VNF. This is unique across the graph.
30056 example: __VNF-ID__
30057 - name: interface-id
30059 description: Unique ID of the interface
30062 example: __INTERFACE-ID__
30065 description: See mis-na-virtualization-platform.yang
30069 example: __CVLAN-TAG__
30072 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
30075 $ref: "#/definitions/cvlan-tag-entry"
30079 summary: update an existing cvlan-tag-entry
30081 Update an existing cvlan-tag-entry
30083 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30084 The PUT operation will entirely replace an existing object.
30085 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30087 Other differences between PUT and PATCH are:
30089 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30090 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30091 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30092 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30101 description: Response codes found in [response codes](https://wiki.onap.org/).
30105 description: Unique id of VNF. This is unique across the graph.
30108 example: __VNF-ID__
30109 - name: interface-id
30111 description: Unique ID of the interface
30114 example: __INTERFACE-ID__
30117 description: See mis-na-virtualization-platform.yang
30121 example: __CVLAN-TAG__
30124 description: cvlan-tag-entry object that needs to be created or updated.
30127 $ref: "#/patchDefinitions/cvlan-tag-entry"
30131 summary: delete an existing cvlan-tag-entry
30132 description: delete an existing cvlan-tag-entry
30133 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30142 description: Response codes found in [response codes](https://wiki.onap.org/).
30146 description: Unique id of VNF. This is unique across the graph.
30149 example: __VNF-ID__
30150 - name: interface-id
30152 description: Unique ID of the interface
30155 example: __INTERFACE-ID__
30158 description: See mis-na-virtualization-platform.yang
30162 example: __CVLAN-TAG__
30163 - name: resource-version
30165 description: resource-version for concurrency
30168 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
30172 summary: returns cvlan-tags
30173 description: returns cvlan-tags
30174 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
30180 description: successful operation
30182 $ref: "#/getDefinitions/cvlan-tags"
30184 description: Response codes found in [response codes](https://wiki.onap.org/).
30188 description: Unique id of VNF. This is unique across the graph.
30191 example: __VNF-ID__
30192 - name: interface-id
30194 description: Unique ID of the interface
30197 example: __INTERFACE-ID__
30200 description: Name of VNF.
30205 description: Alternate name of VNF.
30210 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.
30215 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30218 - name: regional-resource-zone
30220 description: Regional way of organizing pservers, source of truth should define values
30223 - name: prov-status
30225 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30228 - name: heat-stack-id
30230 description: Heat stack id corresponding to this instance, managed by MSO
30235 description: Unique ID of VPE connected to this VCE.
30238 - name: port-group-id
30240 description: Unique ID for port group in vmware
30243 - name: switch-name
30245 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
30248 - name: heat-stack-id
30250 description: Heat stack id corresponding to this instance, managed by MSO
30253 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
30257 summary: see node definition for valid relationships
30258 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
30267 description: Response codes found in [response codes](https://wiki.onap.org/).
30271 description: Unique id of VNF. This is unique across the graph.
30274 example: __VNF-ID__
30275 - name: interface-id
30277 description: Unique ID of the interface
30280 example: __INTERFACE-ID__
30283 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)
30286 $ref: "#/definitions/relationship"
30290 summary: delete an existing relationship
30291 description: delete an existing relationship
30292 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
30301 description: Response codes found in [response codes](https://wiki.onap.org/).
30305 description: Unique id of VNF. This is unique across the graph.
30308 example: __VNF-ID__
30309 - name: interface-id
30311 description: Unique ID of the interface
30314 example: __INTERFACE-ID__
30315 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
30319 summary: returns port-group
30320 description: returns port-group
30321 operationId: getNetworkVcesVcePortGroupsPortGroup
30327 description: successful operation
30329 $ref: "#/getDefinitions/port-group"
30331 description: Response codes found in [response codes](https://wiki.onap.org/).
30335 description: Unique id of VNF. This is unique across the graph.
30338 example: __VNF-ID__
30339 - name: interface-id
30341 description: Unique ID of the interface
30344 example: __INTERFACE-ID__
30347 description: Name of VNF.
30352 description: Alternate name of VNF.
30357 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.
30362 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30365 - name: regional-resource-zone
30367 description: Regional way of organizing pservers, source of truth should define values
30370 - name: prov-status
30372 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30375 - name: heat-stack-id
30377 description: Heat stack id corresponding to this instance, managed by MSO
30382 description: Unique ID of VPE connected to this VCE.
30385 - name: port-group-id
30387 description: Unique ID for port group in vmware
30390 - name: switch-name
30392 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
30395 - name: heat-stack-id
30397 description: Heat stack id corresponding to this instance, managed by MSO
30403 summary: create or update an existing port-group
30405 Create or update an existing port-group.
30407 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30408 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
30417 description: Response codes found in [response codes](https://wiki.onap.org/).
30421 description: Unique id of VNF. This is unique across the graph.
30424 example: __VNF-ID__
30425 - name: interface-id
30427 description: Unique ID of the interface
30430 example: __INTERFACE-ID__
30433 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)
30436 $ref: "#/definitions/port-group"
30440 summary: update an existing port-group
30442 Update an existing port-group
30444 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30445 The PUT operation will entirely replace an existing object.
30446 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30448 Other differences between PUT and PATCH are:
30450 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30451 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30452 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30453 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
30462 description: Response codes found in [response codes](https://wiki.onap.org/).
30466 description: Unique id of VNF. This is unique across the graph.
30469 example: __VNF-ID__
30470 - name: interface-id
30472 description: Unique ID of the interface
30475 example: __INTERFACE-ID__
30478 description: port-group object that needs to be created or updated.
30481 $ref: "#/patchDefinitions/port-group"
30485 summary: delete an existing port-group
30486 description: delete an existing port-group
30487 operationId: deleteNetworkVcesVcePortGroupsPortGroup
30496 description: Response codes found in [response codes](https://wiki.onap.org/).
30500 description: Unique id of VNF. This is unique across the graph.
30503 example: __VNF-ID__
30504 - name: interface-id
30506 description: Unique ID of the interface
30509 example: __INTERFACE-ID__
30510 - name: resource-version
30512 description: resource-version for concurrency
30515 /network/vces/vce/{vnf-id}/port-groups:
30519 summary: returns port-groups
30520 description: returns port-groups
30521 operationId: getNetworkVcesVcePortGroups
30527 description: successful operation
30529 $ref: "#/getDefinitions/port-groups"
30531 description: Response codes found in [response codes](https://wiki.onap.org/).
30535 description: Unique id of VNF. This is unique across the graph.
30538 example: __VNF-ID__
30541 description: Name of VNF.
30546 description: Alternate name of VNF.
30551 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.
30556 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30559 - name: regional-resource-zone
30561 description: Regional way of organizing pservers, source of truth should define values
30564 - name: prov-status
30566 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30569 - name: heat-stack-id
30571 description: Heat stack id corresponding to this instance, managed by MSO
30576 description: Unique ID of VPE connected to this VCE.
30579 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
30583 summary: see node definition for valid relationships
30584 operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
30593 description: Response codes found in [response codes](https://wiki.onap.org/).
30597 description: Unique id of VNF. This is unique across the graph.
30600 example: __VNF-ID__
30603 description: Unique ID for the license group the resource belongs to, should be uuid.
30606 example: __GROUP-UUID__
30607 - name: resource-uuid
30609 description: Unique ID of a license resource.
30612 example: __RESOURCE-UUID__
30615 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)
30618 $ref: "#/definitions/relationship"
30622 summary: delete an existing relationship
30623 description: delete an existing relationship
30624 operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
30633 description: Response codes found in [response codes](https://wiki.onap.org/).
30637 description: Unique id of VNF. This is unique across the graph.
30640 example: __VNF-ID__
30643 description: Unique ID for the license group the resource belongs to, should be uuid.
30646 example: __GROUP-UUID__
30647 - name: resource-uuid
30649 description: Unique ID of a license resource.
30652 example: __RESOURCE-UUID__
30653 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
30657 summary: returns license
30658 description: returns license
30659 operationId: getNetworkVcesVceLicensesLicense
30665 description: successful operation
30667 $ref: "#/getDefinitions/license"
30669 description: Response codes found in [response codes](https://wiki.onap.org/).
30673 description: Unique id of VNF. This is unique across the graph.
30676 example: __VNF-ID__
30679 description: Unique ID for the license group the resource belongs to, should be uuid.
30682 example: __GROUP-UUID__
30683 - name: resource-uuid
30685 description: Unique ID of a license resource.
30688 example: __RESOURCE-UUID__
30691 description: Name of VNF.
30696 description: Alternate name of VNF.
30701 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.
30706 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30709 - name: regional-resource-zone
30711 description: Regional way of organizing pservers, source of truth should define values
30714 - name: prov-status
30716 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30719 - name: heat-stack-id
30721 description: Heat stack id corresponding to this instance, managed by MSO
30726 description: Unique ID of VPE connected to this VCE.
30732 summary: create or update an existing license
30734 Create or update an existing license.
30736 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30737 operationId: createOrUpdateNetworkVcesVceLicensesLicense
30746 description: Response codes found in [response codes](https://wiki.onap.org/).
30750 description: Unique id of VNF. This is unique across the graph.
30753 example: __VNF-ID__
30756 description: Unique ID for the license group the resource belongs to, should be uuid.
30759 example: __GROUP-UUID__
30760 - name: resource-uuid
30762 description: Unique ID of a license resource.
30765 example: __RESOURCE-UUID__
30768 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)
30771 $ref: "#/definitions/license"
30775 summary: update an existing license
30777 Update an existing license
30779 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30780 The PUT operation will entirely replace an existing object.
30781 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30783 Other differences between PUT and PATCH are:
30785 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30786 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30787 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30788 operationId: UpdateNetworkVcesVceLicensesLicense
30797 description: Response codes found in [response codes](https://wiki.onap.org/).
30801 description: Unique id of VNF. This is unique across the graph.
30804 example: __VNF-ID__
30807 description: Unique ID for the license group the resource belongs to, should be uuid.
30810 example: __GROUP-UUID__
30811 - name: resource-uuid
30813 description: Unique ID of a license resource.
30816 example: __RESOURCE-UUID__
30819 description: license object that needs to be created or updated.
30822 $ref: "#/patchDefinitions/license"
30826 summary: delete an existing license
30827 description: delete an existing license
30828 operationId: deleteNetworkVcesVceLicensesLicense
30837 description: Response codes found in [response codes](https://wiki.onap.org/).
30841 description: Unique id of VNF. This is unique across the graph.
30844 example: __VNF-ID__
30847 description: Unique ID for the license group the resource belongs to, should be uuid.
30850 example: __GROUP-UUID__
30851 - name: resource-uuid
30853 description: Unique ID of a license resource.
30856 example: __RESOURCE-UUID__
30857 - name: resource-version
30859 description: resource-version for concurrency
30862 /network/vces/vce/{vnf-id}/licenses:
30866 summary: returns licenses
30867 description: returns licenses
30868 operationId: getNetworkVcesVceLicenses
30874 description: successful operation
30876 $ref: "#/getDefinitions/licenses"
30878 description: Response codes found in [response codes](https://wiki.onap.org/).
30882 description: Unique id of VNF. This is unique across the graph.
30885 example: __VNF-ID__
30888 description: Name of VNF.
30893 description: Alternate name of VNF.
30898 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.
30903 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30906 - name: regional-resource-zone
30908 description: Regional way of organizing pservers, source of truth should define values
30911 - name: prov-status
30913 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30916 - name: heat-stack-id
30918 description: Heat stack id corresponding to this instance, managed by MSO
30923 description: Unique ID of VPE connected to this VCE.
30926 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
30930 summary: see node definition for valid relationships
30931 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
30940 description: Response codes found in [response codes](https://wiki.onap.org/).
30944 description: Unique id of VNF. This is unique across the graph.
30947 example: __VNF-ID__
30950 description: Unique ID for the entitlement group the resource comes from, should be uuid.
30953 example: __GROUP-UUID__
30954 - name: resource-uuid
30956 description: Unique ID of an entitlement resource.
30959 example: __RESOURCE-UUID__
30962 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)
30965 $ref: "#/definitions/relationship"
30969 summary: delete an existing relationship
30970 description: delete an existing relationship
30971 operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
30980 description: Response codes found in [response codes](https://wiki.onap.org/).
30984 description: Unique id of VNF. This is unique across the graph.
30987 example: __VNF-ID__
30990 description: Unique ID for the entitlement group the resource comes from, should be uuid.
30993 example: __GROUP-UUID__
30994 - name: resource-uuid
30996 description: Unique ID of an entitlement resource.
30999 example: __RESOURCE-UUID__
31000 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
31004 summary: returns entitlement
31005 description: returns entitlement
31006 operationId: getNetworkVcesVceEntitlementsEntitlement
31012 description: successful operation
31014 $ref: "#/getDefinitions/entitlement"
31016 description: Response codes found in [response codes](https://wiki.onap.org/).
31020 description: Unique id of VNF. This is unique across the graph.
31023 example: __VNF-ID__
31026 description: Unique ID for the entitlement group the resource comes from, should be uuid.
31029 example: __GROUP-UUID__
31030 - name: resource-uuid
31032 description: Unique ID of an entitlement resource.
31035 example: __RESOURCE-UUID__
31038 description: Name of VNF.
31043 description: Alternate name of VNF.
31048 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.
31053 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31056 - name: regional-resource-zone
31058 description: Regional way of organizing pservers, source of truth should define values
31061 - name: prov-status
31063 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31066 - name: heat-stack-id
31068 description: Heat stack id corresponding to this instance, managed by MSO
31073 description: Unique ID of VPE connected to this VCE.
31079 summary: create or update an existing entitlement
31081 Create or update an existing entitlement.
31083 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31084 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
31093 description: Response codes found in [response codes](https://wiki.onap.org/).
31097 description: Unique id of VNF. This is unique across the graph.
31100 example: __VNF-ID__
31103 description: Unique ID for the entitlement group the resource comes from, should be uuid.
31106 example: __GROUP-UUID__
31107 - name: resource-uuid
31109 description: Unique ID of an entitlement resource.
31112 example: __RESOURCE-UUID__
31115 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)
31118 $ref: "#/definitions/entitlement"
31122 summary: update an existing entitlement
31124 Update an existing entitlement
31126 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31127 The PUT operation will entirely replace an existing object.
31128 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31130 Other differences between PUT and PATCH are:
31132 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31133 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31134 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31135 operationId: UpdateNetworkVcesVceEntitlementsEntitlement
31144 description: Response codes found in [response codes](https://wiki.onap.org/).
31148 description: Unique id of VNF. This is unique across the graph.
31151 example: __VNF-ID__
31154 description: Unique ID for the entitlement group the resource comes from, should be uuid.
31157 example: __GROUP-UUID__
31158 - name: resource-uuid
31160 description: Unique ID of an entitlement resource.
31163 example: __RESOURCE-UUID__
31166 description: entitlement object that needs to be created or updated.
31169 $ref: "#/patchDefinitions/entitlement"
31173 summary: delete an existing entitlement
31174 description: delete an existing entitlement
31175 operationId: deleteNetworkVcesVceEntitlementsEntitlement
31184 description: Response codes found in [response codes](https://wiki.onap.org/).
31188 description: Unique id of VNF. This is unique across the graph.
31191 example: __VNF-ID__
31194 description: Unique ID for the entitlement group the resource comes from, should be uuid.
31197 example: __GROUP-UUID__
31198 - name: resource-uuid
31200 description: Unique ID of an entitlement resource.
31203 example: __RESOURCE-UUID__
31204 - name: resource-version
31206 description: resource-version for concurrency
31209 /network/vces/vce/{vnf-id}/entitlements:
31213 summary: returns entitlements
31214 description: returns entitlements
31215 operationId: getNetworkVcesVceEntitlements
31221 description: successful operation
31223 $ref: "#/getDefinitions/entitlements"
31225 description: Response codes found in [response codes](https://wiki.onap.org/).
31229 description: Unique id of VNF. This is unique across the graph.
31232 example: __VNF-ID__
31235 description: Name of VNF.
31240 description: Alternate name of VNF.
31245 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.
31250 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31253 - name: regional-resource-zone
31255 description: Regional way of organizing pservers, source of truth should define values
31258 - name: prov-status
31260 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31263 - name: heat-stack-id
31265 description: Heat stack id corresponding to this instance, managed by MSO
31270 description: Unique ID of VPE connected to this VCE.
31273 /network/vces/vce/{vnf-id}/relationship-list/relationship:
31277 summary: see node definition for valid relationships
31278 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
31287 description: Response codes found in [response codes](https://wiki.onap.org/).
31291 description: Unique id of VNF. This is unique across the graph.
31294 example: __VNF-ID__
31297 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)
31300 $ref: "#/definitions/relationship"
31304 summary: delete an existing relationship
31305 description: delete an existing relationship
31306 operationId: deleteNetworkVcesVceRelationshipListRelationship
31315 description: Response codes found in [response codes](https://wiki.onap.org/).
31319 description: Unique id of VNF. This is unique across the graph.
31322 example: __VNF-ID__
31323 /network/vces/vce/{vnf-id}:
31327 summary: returns vce
31328 description: returns vce
31329 operationId: getNetworkVcesVce
31335 description: successful operation
31337 $ref: "#/getDefinitions/vce"
31339 description: Response codes found in [response codes](https://wiki.onap.org/).
31343 description: Unique id of VNF. This is unique across the graph.
31346 example: __VNF-ID__
31349 description: Name of VNF.
31354 description: Alternate name of VNF.
31359 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.
31364 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31367 - name: regional-resource-zone
31369 description: Regional way of organizing pservers, source of truth should define values
31372 - name: prov-status
31374 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31377 - name: heat-stack-id
31379 description: Heat stack id corresponding to this instance, managed by MSO
31384 description: Unique ID of VPE connected to this VCE.
31390 summary: create or update an existing vce
31392 Create or update an existing vce.
31394 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31395 operationId: createOrUpdateNetworkVcesVce
31404 description: Response codes found in [response codes](https://wiki.onap.org/).
31408 description: Unique id of VNF. This is unique across the graph.
31411 example: __VNF-ID__
31414 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)
31417 $ref: "#/definitions/vce"
31421 summary: update an existing vce
31423 Update an existing vce
31425 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31426 The PUT operation will entirely replace an existing object.
31427 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31429 Other differences between PUT and PATCH are:
31431 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31432 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31433 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31434 operationId: UpdateNetworkVcesVce
31443 description: Response codes found in [response codes](https://wiki.onap.org/).
31447 description: Unique id of VNF. This is unique across the graph.
31450 example: __VNF-ID__
31453 description: vce object that needs to be created or updated.
31456 $ref: "#/patchDefinitions/vce"
31460 summary: delete an existing vce
31461 description: delete an existing vce
31462 operationId: deleteNetworkVcesVce
31471 description: Response codes found in [response codes](https://wiki.onap.org/).
31475 description: Unique id of VNF. This is unique across the graph.
31478 example: __VNF-ID__
31479 - name: resource-version
31481 description: resource-version for concurrency
31488 summary: returns vces
31489 description: returns vces
31490 operationId: getNetworkVces
31496 description: successful operation
31498 $ref: "#/getDefinitions/vces"
31500 description: Response codes found in [response codes](https://wiki.onap.org/).
31501 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
31505 summary: see node definition for valid relationships
31506 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
31515 description: Response codes found in [response codes](https://wiki.onap.org/).
31519 description: Unique ID of vnfc.
31522 example: __VNFC-NAME__
31525 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)
31528 $ref: "#/definitions/relationship"
31532 summary: delete an existing relationship
31533 description: delete an existing relationship
31534 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
31543 description: Response codes found in [response codes](https://wiki.onap.org/).
31547 description: Unique ID of vnfc.
31550 example: __VNFC-NAME__
31551 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
31555 summary: see node definition for valid relationships
31556 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
31565 description: Response codes found in [response codes](https://wiki.onap.org/).
31569 description: Unique ID of vnfc.
31572 example: __VNFC-NAME__
31573 - name: l3-interface-ipv4-address
31575 description: IP address
31578 example: __L3-INTERFACE-IPV4-ADDRESS__
31581 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
31584 $ref: "#/definitions/relationship"
31588 summary: delete an existing relationship
31589 description: delete an existing relationship
31590 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
31599 description: Response codes found in [response codes](https://wiki.onap.org/).
31603 description: Unique ID of vnfc.
31606 example: __VNFC-NAME__
31607 - name: l3-interface-ipv4-address
31609 description: IP address
31612 example: __L3-INTERFACE-IPV4-ADDRESS__
31613 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
31617 summary: returns l3-interface-ipv4-address-list
31618 description: returns l3-interface-ipv4-address-list
31619 operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31625 description: successful operation
31627 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31629 description: Response codes found in [response codes](https://wiki.onap.org/).
31633 description: Unique ID of vnfc.
31636 example: __VNFC-NAME__
31637 - name: l3-interface-ipv4-address
31639 description: IP address
31642 example: __L3-INTERFACE-IPV4-ADDRESS__
31643 - name: nfc-naming-code
31645 description: Short code that is used in naming instances of the item being modeled
31648 - name: nfc-function
31650 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
31653 - name: prov-status
31655 description: prov status of this vnfc
31658 - name: ipaddress-v4-oam-vip
31660 description: Oam V4 vip address of this vnfc
31667 - name: is-closed-loop-disabled
31671 - name: group-notation
31673 description: Group notation of VNFC
31676 - name: model-invariant-id
31678 description: the ASDC model id for this resource or service model.
31681 - name: model-version-id
31683 description: the ASDC model version for this resource or service model.
31686 - name: vlan-id-inner
31688 description: Inner VLAN tag
31692 - name: neutron-network-id
31694 description: Neutron network id of the interface that address belongs to
31697 - name: neutron-subnet-id
31699 description: Neutron id of subnet that address belongs to
31705 summary: create or update an existing l3-interface-ipv4-address-list
31707 Create or update an existing l3-interface-ipv4-address-list.
31709 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31710 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31719 description: Response codes found in [response codes](https://wiki.onap.org/).
31723 description: Unique ID of vnfc.
31726 example: __VNFC-NAME__
31727 - name: l3-interface-ipv4-address
31729 description: IP address
31732 example: __L3-INTERFACE-IPV4-ADDRESS__
31735 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
31738 $ref: "#/definitions/l3-interface-ipv4-address-list"
31742 summary: update an existing l3-interface-ipv4-address-list
31744 Update an existing l3-interface-ipv4-address-list
31746 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31747 The PUT operation will entirely replace an existing object.
31748 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31750 Other differences between PUT and PATCH are:
31752 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31753 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31754 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31755 operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31764 description: Response codes found in [response codes](https://wiki.onap.org/).
31768 description: Unique ID of vnfc.
31771 example: __VNFC-NAME__
31772 - name: l3-interface-ipv4-address
31774 description: IP address
31777 example: __L3-INTERFACE-IPV4-ADDRESS__
31780 description: l3-interface-ipv4-address-list object that needs to be created or updated.
31783 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31787 summary: delete an existing l3-interface-ipv4-address-list
31788 description: delete an existing l3-interface-ipv4-address-list
31789 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31798 description: Response codes found in [response codes](https://wiki.onap.org/).
31802 description: Unique ID of vnfc.
31805 example: __VNFC-NAME__
31806 - name: l3-interface-ipv4-address
31808 description: IP address
31811 example: __L3-INTERFACE-IPV4-ADDRESS__
31812 - name: resource-version
31814 description: resource-version for concurrency
31817 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
31821 summary: see node definition for valid relationships
31822 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
31831 description: Response codes found in [response codes](https://wiki.onap.org/).
31835 description: Unique ID of vnfc.
31838 example: __VNFC-NAME__
31839 - name: l3-interface-ipv6-address
31841 description: IP address
31844 example: __L3-INTERFACE-IPV6-ADDRESS__
31847 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
31850 $ref: "#/definitions/relationship"
31854 summary: delete an existing relationship
31855 description: delete an existing relationship
31856 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
31865 description: Response codes found in [response codes](https://wiki.onap.org/).
31869 description: Unique ID of vnfc.
31872 example: __VNFC-NAME__
31873 - name: l3-interface-ipv6-address
31875 description: IP address
31878 example: __L3-INTERFACE-IPV6-ADDRESS__
31879 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
31883 summary: returns l3-interface-ipv6-address-list
31884 description: returns l3-interface-ipv6-address-list
31885 operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
31891 description: successful operation
31893 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31895 description: Response codes found in [response codes](https://wiki.onap.org/).
31899 description: Unique ID of vnfc.
31902 example: __VNFC-NAME__
31903 - name: l3-interface-ipv6-address
31905 description: IP address
31908 example: __L3-INTERFACE-IPV6-ADDRESS__
31909 - name: nfc-naming-code
31911 description: Short code that is used in naming instances of the item being modeled
31914 - name: nfc-function
31916 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
31919 - name: prov-status
31921 description: prov status of this vnfc
31924 - name: ipaddress-v4-oam-vip
31926 description: Oam V4 vip address of this vnfc
31933 - name: is-closed-loop-disabled
31937 - name: group-notation
31939 description: Group notation of VNFC
31942 - name: model-invariant-id
31944 description: the ASDC model id for this resource or service model.
31947 - name: model-version-id
31949 description: the ASDC model version for this resource or service model.
31952 - name: vlan-id-inner
31954 description: Inner VLAN tag
31958 - name: neutron-network-id
31960 description: Neutron network id of the interface that address belongs to
31963 - name: neutron-subnet-id
31965 description: Neutron id of subnet that address belongs to
31971 summary: create or update an existing l3-interface-ipv6-address-list
31973 Create or update an existing l3-interface-ipv6-address-list.
31975 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31976 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
31985 description: Response codes found in [response codes](https://wiki.onap.org/).
31989 description: Unique ID of vnfc.
31992 example: __VNFC-NAME__
31993 - name: l3-interface-ipv6-address
31995 description: IP address
31998 example: __L3-INTERFACE-IPV6-ADDRESS__
32001 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
32004 $ref: "#/definitions/l3-interface-ipv6-address-list"
32008 summary: update an existing l3-interface-ipv6-address-list
32010 Update an existing l3-interface-ipv6-address-list
32012 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32013 The PUT operation will entirely replace an existing object.
32014 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32016 Other differences between PUT and PATCH are:
32018 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32019 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32020 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32021 operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
32030 description: Response codes found in [response codes](https://wiki.onap.org/).
32034 description: Unique ID of vnfc.
32037 example: __VNFC-NAME__
32038 - name: l3-interface-ipv6-address
32040 description: IP address
32043 example: __L3-INTERFACE-IPV6-ADDRESS__
32046 description: l3-interface-ipv6-address-list object that needs to be created or updated.
32049 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32053 summary: delete an existing l3-interface-ipv6-address-list
32054 description: delete an existing l3-interface-ipv6-address-list
32055 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
32064 description: Response codes found in [response codes](https://wiki.onap.org/).
32068 description: Unique ID of vnfc.
32071 example: __VNFC-NAME__
32072 - name: l3-interface-ipv6-address
32074 description: IP address
32077 example: __L3-INTERFACE-IPV6-ADDRESS__
32078 - name: resource-version
32080 description: resource-version for concurrency
32083 /network/vnfcs/vnfc/{vnfc-name}:
32087 summary: returns vnfc
32088 description: returns vnfc
32089 operationId: getNetworkVnfcsVnfc
32095 description: successful operation
32097 $ref: "#/getDefinitions/vnfc"
32099 description: Response codes found in [response codes](https://wiki.onap.org/).
32103 description: Unique ID of vnfc.
32106 example: __VNFC-NAME__
32107 - name: nfc-naming-code
32109 description: Short code that is used in naming instances of the item being modeled
32112 - name: nfc-function
32114 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
32117 - name: prov-status
32119 description: prov status of this vnfc
32122 - name: ipaddress-v4-oam-vip
32124 description: Oam V4 vip address of this vnfc
32131 - name: is-closed-loop-disabled
32135 - name: group-notation
32137 description: Group notation of VNFC
32140 - name: model-invariant-id
32142 description: the ASDC model id for this resource or service model.
32145 - name: model-version-id
32147 description: the ASDC model version for this resource or service model.
32153 summary: create or update an existing vnfc
32155 Create or update an existing vnfc.
32157 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32158 operationId: createOrUpdateNetworkVnfcsVnfc
32167 description: Response codes found in [response codes](https://wiki.onap.org/).
32171 description: Unique ID of vnfc.
32174 example: __VNFC-NAME__
32177 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)
32180 $ref: "#/definitions/vnfc"
32184 summary: update an existing vnfc
32186 Update an existing vnfc
32188 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32189 The PUT operation will entirely replace an existing object.
32190 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32192 Other differences between PUT and PATCH are:
32194 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32195 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32196 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32197 operationId: UpdateNetworkVnfcsVnfc
32206 description: Response codes found in [response codes](https://wiki.onap.org/).
32210 description: Unique ID of vnfc.
32213 example: __VNFC-NAME__
32216 description: vnfc object that needs to be created or updated.
32219 $ref: "#/patchDefinitions/vnfc"
32223 summary: delete an existing vnfc
32224 description: delete an existing vnfc
32225 operationId: deleteNetworkVnfcsVnfc
32234 description: Response codes found in [response codes](https://wiki.onap.org/).
32238 description: Unique ID of vnfc.
32241 example: __VNFC-NAME__
32242 - name: resource-version
32244 description: resource-version for concurrency
32251 summary: returns vnfcs
32252 description: returns vnfcs
32253 operationId: getNetworkVnfcs
32259 description: successful operation
32261 $ref: "#/getDefinitions/vnfcs"
32263 description: Response codes found in [response codes](https://wiki.onap.org/).
32264 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
32268 summary: see node definition for valid relationships
32269 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
32278 description: Response codes found in [response codes](https://wiki.onap.org/).
32282 description: Network ID, should be uuid. Unique across A&AI.
32285 example: __NETWORK-ID__
32288 description: Subnet ID, should be UUID.
32291 example: __SUBNET-ID__
32292 - name: host-route-id
32294 description: host-route id
32297 example: __HOST-ROUTE-ID__
32300 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
32303 $ref: "#/definitions/relationship"
32307 summary: delete an existing relationship
32308 description: delete an existing relationship
32309 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
32318 description: Response codes found in [response codes](https://wiki.onap.org/).
32322 description: Network ID, should be uuid. Unique across A&AI.
32325 example: __NETWORK-ID__
32328 description: Subnet ID, should be UUID.
32331 example: __SUBNET-ID__
32332 - name: host-route-id
32334 description: host-route id
32337 example: __HOST-ROUTE-ID__
32338 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
32342 summary: returns host-route
32343 description: returns host-route
32344 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32350 description: successful operation
32352 $ref: "#/getDefinitions/host-route"
32354 description: Response codes found in [response codes](https://wiki.onap.org/).
32358 description: Network ID, should be uuid. Unique across A&AI.
32361 example: __NETWORK-ID__
32364 description: Subnet ID, should be UUID.
32367 example: __SUBNET-ID__
32368 - name: host-route-id
32370 description: host-route id
32373 example: __HOST-ROUTE-ID__
32374 - name: network-name
32376 description: Name of the network, governed by some naming convention..
32379 - name: network-role
32381 description: Role the network plans - who defines these values?
32386 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
32389 - name: heat-stack-id
32391 description: Heat stack id corresponding to this instance, managed by MSO
32394 - name: contrail-network-fqdn
32396 description: Contrail FQDN for the network
32399 - name: model-invariant-id
32401 description: the ASDC model id for this resource or service model.
32404 - name: model-version-id
32406 description: the ASDC model version for this resource or service model.
32409 - name: widget-model-id
32411 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32414 - name: widget-model-version
32416 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32419 - name: subnet-name
32421 description: Name associated with the subnet.
32427 summary: create or update an existing host-route
32429 Create or update an existing host-route.
32431 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32432 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32441 description: Response codes found in [response codes](https://wiki.onap.org/).
32445 description: Network ID, should be uuid. Unique across A&AI.
32448 example: __NETWORK-ID__
32451 description: Subnet ID, should be UUID.
32454 example: __SUBNET-ID__
32455 - name: host-route-id
32457 description: host-route id
32460 example: __HOST-ROUTE-ID__
32463 description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
32466 $ref: "#/definitions/host-route"
32470 summary: update an existing host-route
32472 Update an existing host-route
32474 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32475 The PUT operation will entirely replace an existing object.
32476 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32478 Other differences between PUT and PATCH are:
32480 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32481 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32482 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32483 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32492 description: Response codes found in [response codes](https://wiki.onap.org/).
32496 description: Network ID, should be uuid. Unique across A&AI.
32499 example: __NETWORK-ID__
32502 description: Subnet ID, should be UUID.
32505 example: __SUBNET-ID__
32506 - name: host-route-id
32508 description: host-route id
32511 example: __HOST-ROUTE-ID__
32514 description: host-route object that needs to be created or updated.
32517 $ref: "#/patchDefinitions/host-route"
32521 summary: delete an existing host-route
32522 description: delete an existing host-route
32523 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32532 description: Response codes found in [response codes](https://wiki.onap.org/).
32536 description: Network ID, should be uuid. Unique across A&AI.
32539 example: __NETWORK-ID__
32542 description: Subnet ID, should be UUID.
32545 example: __SUBNET-ID__
32546 - name: host-route-id
32548 description: host-route id
32551 example: __HOST-ROUTE-ID__
32552 - name: resource-version
32554 description: resource-version for concurrency
32557 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
32561 summary: returns host-routes
32562 description: returns host-routes
32563 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
32569 description: successful operation
32571 $ref: "#/getDefinitions/host-routes"
32573 description: Response codes found in [response codes](https://wiki.onap.org/).
32577 description: Network ID, should be uuid. Unique across A&AI.
32580 example: __NETWORK-ID__
32583 description: Subnet ID, should be UUID.
32586 example: __SUBNET-ID__
32587 - name: network-name
32589 description: Name of the network, governed by some naming convention..
32592 - name: network-role
32594 description: Role the network plans - who defines these values?
32599 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
32602 - name: heat-stack-id
32604 description: Heat stack id corresponding to this instance, managed by MSO
32607 - name: contrail-network-fqdn
32609 description: Contrail FQDN for the network
32612 - name: model-invariant-id
32614 description: the ASDC model id for this resource or service model.
32617 - name: model-version-id
32619 description: the ASDC model version for this resource or service model.
32622 - name: widget-model-id
32624 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32627 - name: widget-model-version
32629 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32632 - name: subnet-name
32634 description: Name associated with the subnet.
32637 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
32641 summary: see node definition for valid relationships
32642 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
32651 description: Response codes found in [response codes](https://wiki.onap.org/).
32655 description: Network ID, should be uuid. Unique across A&AI.
32658 example: __NETWORK-ID__
32661 description: Subnet ID, should be UUID.
32664 example: __SUBNET-ID__
32667 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
32670 $ref: "#/definitions/relationship"
32674 summary: delete an existing relationship
32675 description: delete an existing relationship
32676 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
32685 description: Response codes found in [response codes](https://wiki.onap.org/).
32689 description: Network ID, should be uuid. Unique across A&AI.
32692 example: __NETWORK-ID__
32695 description: Subnet ID, should be UUID.
32698 example: __SUBNET-ID__
32699 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
32703 summary: returns subnet
32704 description: returns subnet
32705 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
32711 description: successful operation
32713 $ref: "#/getDefinitions/subnet"
32715 description: Response codes found in [response codes](https://wiki.onap.org/).
32719 description: Network ID, should be uuid. Unique across A&AI.
32722 example: __NETWORK-ID__
32725 description: Subnet ID, should be UUID.
32728 example: __SUBNET-ID__
32729 - name: network-name
32731 description: Name of the network, governed by some naming convention..
32734 - name: network-role
32736 description: Role the network plans - who defines these values?
32741 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
32744 - name: heat-stack-id
32746 description: Heat stack id corresponding to this instance, managed by MSO
32749 - name: contrail-network-fqdn
32751 description: Contrail FQDN for the network
32754 - name: model-invariant-id
32756 description: the ASDC model id for this resource or service model.
32759 - name: model-version-id
32761 description: the ASDC model version for this resource or service model.
32764 - name: widget-model-id
32766 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32769 - name: widget-model-version
32771 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32774 - name: subnet-name
32776 description: Name associated with the subnet.
32782 summary: create or update an existing subnet
32784 Create or update an existing subnet.
32786 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32787 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
32796 description: Response codes found in [response codes](https://wiki.onap.org/).
32800 description: Network ID, should be uuid. Unique across A&AI.
32803 example: __NETWORK-ID__
32806 description: Subnet ID, should be UUID.
32809 example: __SUBNET-ID__
32812 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
32815 $ref: "#/definitions/subnet"
32819 summary: update an existing subnet
32821 Update an existing subnet
32823 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32824 The PUT operation will entirely replace an existing object.
32825 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32827 Other differences between PUT and PATCH are:
32829 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32830 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32831 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32832 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
32841 description: Response codes found in [response codes](https://wiki.onap.org/).
32845 description: Network ID, should be uuid. Unique across A&AI.
32848 example: __NETWORK-ID__
32851 description: Subnet ID, should be UUID.
32854 example: __SUBNET-ID__
32857 description: subnet object that needs to be created or updated.
32860 $ref: "#/patchDefinitions/subnet"
32864 summary: delete an existing subnet
32865 description: delete an existing subnet
32866 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
32875 description: Response codes found in [response codes](https://wiki.onap.org/).
32879 description: Network ID, should be uuid. Unique across A&AI.
32882 example: __NETWORK-ID__
32885 description: Subnet ID, should be UUID.
32888 example: __SUBNET-ID__
32889 - name: resource-version
32891 description: resource-version for concurrency
32894 /network/l3-networks/l3-network/{network-id}/subnets:
32898 summary: returns subnets
32899 description: returns subnets
32900 operationId: getNetworkL3NetworksL3NetworkSubnets
32906 description: successful operation
32908 $ref: "#/getDefinitions/subnets"
32910 description: Response codes found in [response codes](https://wiki.onap.org/).
32914 description: Network ID, should be uuid. Unique across A&AI.
32917 example: __NETWORK-ID__
32918 - name: network-name
32920 description: Name of the network, governed by some naming convention..
32923 - name: network-role
32925 description: Role the network plans - who defines these values?
32930 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
32933 - name: heat-stack-id
32935 description: Heat stack id corresponding to this instance, managed by MSO
32938 - name: contrail-network-fqdn
32940 description: Contrail FQDN for the network
32943 - name: model-invariant-id
32945 description: the ASDC model id for this resource or service model.
32948 - name: model-version-id
32950 description: the ASDC model version for this resource or service model.
32953 - name: widget-model-id
32955 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32958 - name: widget-model-version
32960 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32963 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
32967 summary: see node definition for valid relationships
32968 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
32977 description: Response codes found in [response codes](https://wiki.onap.org/).
32981 description: Network ID, should be uuid. Unique across A&AI.
32984 example: __NETWORK-ID__
32985 - name: vlan-id-inner
32991 example: __VLAN-ID-INNER__
32994 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
32997 $ref: "#/definitions/relationship"
33001 summary: delete an existing relationship
33002 description: delete an existing relationship
33003 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
33012 description: Response codes found in [response codes](https://wiki.onap.org/).
33016 description: Network ID, should be uuid. Unique across A&AI.
33019 example: __NETWORK-ID__
33020 - name: vlan-id-inner
33026 example: __VLAN-ID-INNER__
33027 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
33031 summary: returns ctag-assignment
33032 description: returns ctag-assignment
33033 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33039 description: successful operation
33041 $ref: "#/getDefinitions/ctag-assignment"
33043 description: Response codes found in [response codes](https://wiki.onap.org/).
33047 description: Network ID, should be uuid. Unique across A&AI.
33050 example: __NETWORK-ID__
33051 - name: vlan-id-inner
33057 example: __VLAN-ID-INNER__
33058 - name: network-name
33060 description: Name of the network, governed by some naming convention..
33063 - name: network-role
33065 description: Role the network plans - who defines these values?
33070 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
33073 - name: heat-stack-id
33075 description: Heat stack id corresponding to this instance, managed by MSO
33078 - name: contrail-network-fqdn
33080 description: Contrail FQDN for the network
33083 - name: model-invariant-id
33085 description: the ASDC model id for this resource or service model.
33088 - name: model-version-id
33090 description: the ASDC model version for this resource or service model.
33093 - name: widget-model-id
33095 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33098 - name: widget-model-version
33100 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33106 summary: create or update an existing ctag-assignment
33108 Create or update an existing ctag-assignment.
33110 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33111 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33120 description: Response codes found in [response codes](https://wiki.onap.org/).
33124 description: Network ID, should be uuid. Unique across A&AI.
33127 example: __NETWORK-ID__
33128 - name: vlan-id-inner
33134 example: __VLAN-ID-INNER__
33137 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
33140 $ref: "#/definitions/ctag-assignment"
33144 summary: update an existing ctag-assignment
33146 Update an existing ctag-assignment
33148 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33149 The PUT operation will entirely replace an existing object.
33150 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33152 Other differences between PUT and PATCH are:
33154 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33155 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33156 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33157 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33166 description: Response codes found in [response codes](https://wiki.onap.org/).
33170 description: Network ID, should be uuid. Unique across A&AI.
33173 example: __NETWORK-ID__
33174 - name: vlan-id-inner
33180 example: __VLAN-ID-INNER__
33183 description: ctag-assignment object that needs to be created or updated.
33186 $ref: "#/patchDefinitions/ctag-assignment"
33190 summary: delete an existing ctag-assignment
33191 description: delete an existing ctag-assignment
33192 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33201 description: Response codes found in [response codes](https://wiki.onap.org/).
33205 description: Network ID, should be uuid. Unique across A&AI.
33208 example: __NETWORK-ID__
33209 - name: vlan-id-inner
33215 example: __VLAN-ID-INNER__
33216 - name: resource-version
33218 description: resource-version for concurrency
33221 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
33225 summary: returns ctag-assignments
33226 description: returns ctag-assignments
33227 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
33233 description: successful operation
33235 $ref: "#/getDefinitions/ctag-assignments"
33237 description: Response codes found in [response codes](https://wiki.onap.org/).
33241 description: Network ID, should be uuid. Unique across A&AI.
33244 example: __NETWORK-ID__
33245 - name: network-name
33247 description: Name of the network, governed by some naming convention..
33250 - name: network-role
33252 description: Role the network plans - who defines these values?
33257 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
33260 - name: heat-stack-id
33262 description: Heat stack id corresponding to this instance, managed by MSO
33265 - name: contrail-network-fqdn
33267 description: Contrail FQDN for the network
33270 - name: model-invariant-id
33272 description: the ASDC model id for this resource or service model.
33275 - name: model-version-id
33277 description: the ASDC model version for this resource or service model.
33280 - name: widget-model-id
33282 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33285 - name: widget-model-version
33287 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33290 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
33294 summary: see node definition for valid relationships
33295 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
33304 description: Response codes found in [response codes](https://wiki.onap.org/).
33308 description: Network ID, should be uuid. Unique across A&AI.
33311 example: __NETWORK-ID__
33312 - name: segmentation-id
33314 description: Route Table Reference id, UUID assigned to this instance.
33317 example: __SEGMENTATION-ID__
33320 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
33323 $ref: "#/definitions/relationship"
33327 summary: delete an existing relationship
33328 description: delete an existing relationship
33329 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
33338 description: Response codes found in [response codes](https://wiki.onap.org/).
33342 description: Network ID, should be uuid. Unique across A&AI.
33345 example: __NETWORK-ID__
33346 - name: segmentation-id
33348 description: Route Table Reference id, UUID assigned to this instance.
33351 example: __SEGMENTATION-ID__
33352 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
33356 summary: returns segmentation-assignment
33357 description: returns segmentation-assignment
33358 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33364 description: successful operation
33366 $ref: "#/getDefinitions/segmentation-assignment"
33368 description: Response codes found in [response codes](https://wiki.onap.org/).
33372 description: Network ID, should be uuid. Unique across A&AI.
33375 example: __NETWORK-ID__
33376 - name: segmentation-id
33378 description: Route Table Reference id, UUID assigned to this instance.
33381 example: __SEGMENTATION-ID__
33382 - name: network-name
33384 description: Name of the network, governed by some naming convention..
33387 - name: network-role
33389 description: Role the network plans - who defines these values?
33394 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
33397 - name: heat-stack-id
33399 description: Heat stack id corresponding to this instance, managed by MSO
33402 - name: contrail-network-fqdn
33404 description: Contrail FQDN for the network
33407 - name: model-invariant-id
33409 description: the ASDC model id for this resource or service model.
33412 - name: model-version-id
33414 description: the ASDC model version for this resource or service model.
33417 - name: widget-model-id
33419 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33422 - name: widget-model-version
33424 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33430 summary: create or update an existing segmentation-assignment
33432 Create or update an existing segmentation-assignment.
33434 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33435 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33444 description: Response codes found in [response codes](https://wiki.onap.org/).
33448 description: Network ID, should be uuid. Unique across A&AI.
33451 example: __NETWORK-ID__
33452 - name: segmentation-id
33454 description: Route Table Reference id, UUID assigned to this instance.
33457 example: __SEGMENTATION-ID__
33460 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
33463 $ref: "#/definitions/segmentation-assignment"
33467 summary: update an existing segmentation-assignment
33469 Update an existing segmentation-assignment
33471 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33472 The PUT operation will entirely replace an existing object.
33473 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33475 Other differences between PUT and PATCH are:
33477 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33478 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33479 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33480 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33489 description: Response codes found in [response codes](https://wiki.onap.org/).
33493 description: Network ID, should be uuid. Unique across A&AI.
33496 example: __NETWORK-ID__
33497 - name: segmentation-id
33499 description: Route Table Reference id, UUID assigned to this instance.
33502 example: __SEGMENTATION-ID__
33505 description: segmentation-assignment object that needs to be created or updated.
33508 $ref: "#/patchDefinitions/segmentation-assignment"
33512 summary: delete an existing segmentation-assignment
33513 description: delete an existing segmentation-assignment
33514 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33523 description: Response codes found in [response codes](https://wiki.onap.org/).
33527 description: Network ID, should be uuid. Unique across A&AI.
33530 example: __NETWORK-ID__
33531 - name: segmentation-id
33533 description: Route Table Reference id, UUID assigned to this instance.
33536 example: __SEGMENTATION-ID__
33537 - name: resource-version
33539 description: resource-version for concurrency
33542 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
33546 summary: returns segmentation-assignments
33547 description: returns segmentation-assignments
33548 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
33554 description: successful operation
33556 $ref: "#/getDefinitions/segmentation-assignments"
33558 description: Response codes found in [response codes](https://wiki.onap.org/).
33562 description: Network ID, should be uuid. Unique across A&AI.
33565 example: __NETWORK-ID__
33566 - name: network-name
33568 description: Name of the network, governed by some naming convention..
33571 - name: network-role
33573 description: Role the network plans - who defines these values?
33578 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
33581 - name: heat-stack-id
33583 description: Heat stack id corresponding to this instance, managed by MSO
33586 - name: contrail-network-fqdn
33588 description: Contrail FQDN for the network
33591 - name: model-invariant-id
33593 description: the ASDC model id for this resource or service model.
33596 - name: model-version-id
33598 description: the ASDC model version for this resource or service model.
33601 - name: widget-model-id
33603 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33606 - name: widget-model-version
33608 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33611 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
33615 summary: see node definition for valid relationships
33616 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
33625 description: Response codes found in [response codes](https://wiki.onap.org/).
33629 description: Network ID, should be uuid. Unique across A&AI.
33632 example: __NETWORK-ID__
33635 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)
33638 $ref: "#/definitions/relationship"
33642 summary: delete an existing relationship
33643 description: delete an existing relationship
33644 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
33653 description: Response codes found in [response codes](https://wiki.onap.org/).
33657 description: Network ID, should be uuid. Unique across A&AI.
33660 example: __NETWORK-ID__
33661 /network/l3-networks/l3-network/{network-id}:
33665 summary: returns l3-network
33666 description: returns l3-network
33667 operationId: getNetworkL3NetworksL3Network
33673 description: successful operation
33675 $ref: "#/getDefinitions/l3-network"
33677 description: Response codes found in [response codes](https://wiki.onap.org/).
33681 description: Network ID, should be uuid. Unique across A&AI.
33684 example: __NETWORK-ID__
33685 - name: network-name
33687 description: Name of the network, governed by some naming convention..
33690 - name: network-role
33692 description: Role the network plans - who defines these values?
33697 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
33700 - name: heat-stack-id
33702 description: Heat stack id corresponding to this instance, managed by MSO
33705 - name: contrail-network-fqdn
33707 description: Contrail FQDN for the network
33710 - name: model-invariant-id
33712 description: the ASDC model id for this resource or service model.
33715 - name: model-version-id
33717 description: the ASDC model version for this resource or service model.
33720 - name: widget-model-id
33722 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33725 - name: widget-model-version
33727 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33733 summary: create or update an existing l3-network
33735 Create or update an existing l3-network.
33737 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33738 operationId: createOrUpdateNetworkL3NetworksL3Network
33747 description: Response codes found in [response codes](https://wiki.onap.org/).
33751 description: Network ID, should be uuid. Unique across A&AI.
33754 example: __NETWORK-ID__
33757 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)
33760 $ref: "#/definitions/l3-network"
33764 summary: update an existing l3-network
33766 Update an existing l3-network
33768 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33769 The PUT operation will entirely replace an existing object.
33770 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33772 Other differences between PUT and PATCH are:
33774 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33775 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33776 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33777 operationId: UpdateNetworkL3NetworksL3Network
33786 description: Response codes found in [response codes](https://wiki.onap.org/).
33790 description: Network ID, should be uuid. Unique across A&AI.
33793 example: __NETWORK-ID__
33796 description: l3-network object that needs to be created or updated.
33799 $ref: "#/patchDefinitions/l3-network"
33803 summary: delete an existing l3-network
33804 description: delete an existing l3-network
33805 operationId: deleteNetworkL3NetworksL3Network
33814 description: Response codes found in [response codes](https://wiki.onap.org/).
33818 description: Network ID, should be uuid. Unique across A&AI.
33821 example: __NETWORK-ID__
33822 - name: resource-version
33824 description: resource-version for concurrency
33827 /network/l3-networks:
33831 summary: returns l3-networks
33832 description: returns l3-networks
33833 operationId: getNetworkL3Networks
33839 description: successful operation
33841 $ref: "#/getDefinitions/l3-networks"
33843 description: Response codes found in [response codes](https://wiki.onap.org/).
33844 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
33848 summary: see node definition for valid relationships
33849 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
33858 description: Response codes found in [response codes](https://wiki.onap.org/).
33860 - name: network-policy-id
33862 description: UUID representing unique key to this instance
33865 example: __NETWORK-POLICY-ID__
33868 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)
33871 $ref: "#/definitions/relationship"
33875 summary: delete an existing relationship
33876 description: delete an existing relationship
33877 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
33886 description: Response codes found in [response codes](https://wiki.onap.org/).
33888 - name: network-policy-id
33890 description: UUID representing unique key to this instance
33893 example: __NETWORK-POLICY-ID__
33894 /network/network-policies/network-policy/{network-policy-id}:
33898 summary: returns network-policy
33899 description: returns network-policy
33900 operationId: getNetworkNetworkPoliciesNetworkPolicy
33906 description: successful operation
33908 $ref: "#/getDefinitions/network-policy"
33910 description: Response codes found in [response codes](https://wiki.onap.org/).
33912 - name: network-policy-id
33914 description: UUID representing unique key to this instance
33917 example: __NETWORK-POLICY-ID__
33918 - name: network-policy-fqdn
33920 description: Contrail FQDN for the policy
33926 summary: create or update an existing network-policy
33928 Create or update an existing network-policy.
33930 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33931 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
33940 description: Response codes found in [response codes](https://wiki.onap.org/).
33942 - name: network-policy-id
33944 description: UUID representing unique key to this instance
33947 example: __NETWORK-POLICY-ID__
33950 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)
33953 $ref: "#/definitions/network-policy"
33957 summary: update an existing network-policy
33959 Update an existing network-policy
33961 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33962 The PUT operation will entirely replace an existing object.
33963 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33965 Other differences between PUT and PATCH are:
33967 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33968 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33969 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33970 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
33979 description: Response codes found in [response codes](https://wiki.onap.org/).
33981 - name: network-policy-id
33983 description: UUID representing unique key to this instance
33986 example: __NETWORK-POLICY-ID__
33989 description: network-policy object that needs to be created or updated.
33992 $ref: "#/patchDefinitions/network-policy"
33996 summary: delete an existing network-policy
33997 description: delete an existing network-policy
33998 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
34007 description: Response codes found in [response codes](https://wiki.onap.org/).
34009 - name: network-policy-id
34011 description: UUID representing unique key to this instance
34014 example: __NETWORK-POLICY-ID__
34015 - name: resource-version
34017 description: resource-version for concurrency
34020 /network/network-policies:
34024 summary: returns network-policies
34025 description: returns network-policies
34026 operationId: getNetworkNetworkPolicies
34032 description: successful operation
34034 $ref: "#/getDefinitions/network-policies"
34036 description: Response codes found in [response codes](https://wiki.onap.org/).
34037 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
34041 summary: see node definition for valid relationships
34042 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
34051 description: Response codes found in [response codes](https://wiki.onap.org/).
34055 description: Unique id of VNF. This is unique across the graph.
34058 example: __VNF-ID__
34061 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)
34064 $ref: "#/definitions/relationship"
34068 summary: delete an existing relationship
34069 description: delete an existing relationship
34070 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
34079 description: Response codes found in [response codes](https://wiki.onap.org/).
34083 description: Unique id of VNF. This is unique across the graph.
34086 example: __VNF-ID__
34087 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34091 summary: see node definition for valid relationships
34092 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34101 description: Response codes found in [response codes](https://wiki.onap.org/).
34105 description: Unique id of VNF. This is unique across the graph.
34108 example: __VNF-ID__
34109 - name: interface-name
34111 description: Name given to the interface
34114 example: __INTERFACE-NAME__
34115 - name: vlan-interface
34117 description: String that identifies the interface
34120 example: __VLAN-INTERFACE__
34123 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
34126 $ref: "#/definitions/relationship"
34130 summary: delete an existing relationship
34131 description: delete an existing relationship
34132 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34141 description: Response codes found in [response codes](https://wiki.onap.org/).
34145 description: Unique id of VNF. This is unique across the graph.
34148 example: __VNF-ID__
34149 - name: interface-name
34151 description: Name given to the interface
34154 example: __INTERFACE-NAME__
34155 - name: vlan-interface
34157 description: String that identifies the interface
34160 example: __VLAN-INTERFACE__
34161 /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:
34165 summary: see node definition for valid relationships
34166 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34175 description: Response codes found in [response codes](https://wiki.onap.org/).
34179 description: Unique id of VNF. This is unique across the graph.
34182 example: __VNF-ID__
34183 - name: interface-name
34185 description: Name given to the interface
34188 example: __INTERFACE-NAME__
34189 - name: vlan-interface
34191 description: String that identifies the interface
34194 example: __VLAN-INTERFACE__
34195 - name: l3-interface-ipv4-address
34197 description: IP address
34200 example: __L3-INTERFACE-IPV4-ADDRESS__
34203 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34206 $ref: "#/definitions/relationship"
34210 summary: delete an existing relationship
34211 description: delete an existing relationship
34212 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34221 description: Response codes found in [response codes](https://wiki.onap.org/).
34225 description: Unique id of VNF. This is unique across the graph.
34228 example: __VNF-ID__
34229 - name: interface-name
34231 description: Name given to the interface
34234 example: __INTERFACE-NAME__
34235 - name: vlan-interface
34237 description: String that identifies the interface
34240 example: __VLAN-INTERFACE__
34241 - name: l3-interface-ipv4-address
34243 description: IP address
34246 example: __L3-INTERFACE-IPV4-ADDRESS__
34247 /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}:
34251 summary: returns l3-interface-ipv4-address-list
34252 description: returns l3-interface-ipv4-address-list
34253 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34259 description: successful operation
34261 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
34263 description: Response codes found in [response codes](https://wiki.onap.org/).
34267 description: Unique id of VNF. This is unique across the graph.
34270 example: __VNF-ID__
34271 - name: interface-name
34273 description: Name given to the interface
34276 example: __INTERFACE-NAME__
34277 - name: vlan-interface
34279 description: String that identifies the interface
34282 example: __VLAN-INTERFACE__
34283 - name: l3-interface-ipv4-address
34285 description: IP address
34288 example: __L3-INTERFACE-IPV4-ADDRESS__
34291 description: Name of VNF.
34296 description: Alternate name of VNF.
34301 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.
34306 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
34309 - name: regional-resource-zone
34311 description: Regional way of organizing pservers, source of truth should define values
34314 - name: prov-status
34316 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34319 - name: heat-stack-id
34321 description: Heat stack id corresponding to this instance, managed by MSO
34328 - name: is-closed-loop-disabled
34332 - name: model-invariant-id
34334 description: the ASDC model id for this resource or service model.
34337 - name: model-version-id
34339 description: the ASDC model version for this resource or service model.
34342 - name: widget-model-id
34344 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34347 - name: widget-model-version
34349 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34354 description: Generic description of the type of NF
34357 - name: nf-function
34359 description: English description of Network function that the specific VNF deployment is providing
34364 description: role in the network that this model will be providing
34367 - name: nf-naming-code
34369 description: string assigned to this model used for naming purposes
34372 - name: interface-id
34374 description: ID of interface
34379 description: MAC address for the interface
34382 - name: network-name
34384 description: Name of the network
34387 - name: vlan-id-inner
34389 description: Inner VLAN tag
34395 description: This indicates the customers VPN ID associated with this vlan
34398 - name: vlan-id-inner
34400 description: Inner VLAN tag
34404 - name: neutron-network-id
34406 description: Neutron network id of the interface that address belongs to
34409 - name: neutron-subnet-id
34411 description: Neutron id of subnet that address belongs to
34417 summary: create or update an existing l3-interface-ipv4-address-list
34419 Create or update an existing l3-interface-ipv4-address-list.
34421 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34422 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34431 description: Response codes found in [response codes](https://wiki.onap.org/).
34435 description: Unique id of VNF. This is unique across the graph.
34438 example: __VNF-ID__
34439 - name: interface-name
34441 description: Name given to the interface
34444 example: __INTERFACE-NAME__
34445 - name: vlan-interface
34447 description: String that identifies the interface
34450 example: __VLAN-INTERFACE__
34451 - name: l3-interface-ipv4-address
34453 description: IP address
34456 example: __L3-INTERFACE-IPV4-ADDRESS__
34459 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34462 $ref: "#/definitions/l3-interface-ipv4-address-list"
34466 summary: update an existing l3-interface-ipv4-address-list
34468 Update an existing l3-interface-ipv4-address-list
34470 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34471 The PUT operation will entirely replace an existing object.
34472 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34474 Other differences between PUT and PATCH are:
34476 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34477 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34478 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34479 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34488 description: Response codes found in [response codes](https://wiki.onap.org/).
34492 description: Unique id of VNF. This is unique across the graph.
34495 example: __VNF-ID__
34496 - name: interface-name
34498 description: Name given to the interface
34501 example: __INTERFACE-NAME__
34502 - name: vlan-interface
34504 description: String that identifies the interface
34507 example: __VLAN-INTERFACE__
34508 - name: l3-interface-ipv4-address
34510 description: IP address
34513 example: __L3-INTERFACE-IPV4-ADDRESS__
34516 description: l3-interface-ipv4-address-list object that needs to be created or updated.
34519 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34523 summary: delete an existing l3-interface-ipv4-address-list
34524 description: delete an existing l3-interface-ipv4-address-list
34525 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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 given to the interface
34547 example: __INTERFACE-NAME__
34548 - name: vlan-interface
34550 description: String that identifies the interface
34553 example: __VLAN-INTERFACE__
34554 - name: l3-interface-ipv4-address
34556 description: IP address
34559 example: __L3-INTERFACE-IPV4-ADDRESS__
34560 - name: resource-version
34562 description: resource-version for concurrency
34565 /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:
34569 summary: see node definition for valid relationships
34570 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34579 description: Response codes found in [response codes](https://wiki.onap.org/).
34583 description: Unique id of VNF. This is unique across the graph.
34586 example: __VNF-ID__
34587 - name: interface-name
34589 description: Name given to the interface
34592 example: __INTERFACE-NAME__
34593 - name: vlan-interface
34595 description: String that identifies the interface
34598 example: __VLAN-INTERFACE__
34599 - name: l3-interface-ipv6-address
34601 description: IP address
34604 example: __L3-INTERFACE-IPV6-ADDRESS__
34607 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34610 $ref: "#/definitions/relationship"
34614 summary: delete an existing relationship
34615 description: delete an existing relationship
34616 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34625 description: Response codes found in [response codes](https://wiki.onap.org/).
34629 description: Unique id of VNF. This is unique across the graph.
34632 example: __VNF-ID__
34633 - name: interface-name
34635 description: Name given to the interface
34638 example: __INTERFACE-NAME__
34639 - name: vlan-interface
34641 description: String that identifies the interface
34644 example: __VLAN-INTERFACE__
34645 - name: l3-interface-ipv6-address
34647 description: IP address
34650 example: __L3-INTERFACE-IPV6-ADDRESS__
34651 /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}:
34655 summary: returns l3-interface-ipv6-address-list
34656 description: returns l3-interface-ipv6-address-list
34657 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34663 description: successful operation
34665 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34667 description: Response codes found in [response codes](https://wiki.onap.org/).
34671 description: Unique id of VNF. This is unique across the graph.
34674 example: __VNF-ID__
34675 - name: interface-name
34677 description: Name given to the interface
34680 example: __INTERFACE-NAME__
34681 - name: vlan-interface
34683 description: String that identifies the interface
34686 example: __VLAN-INTERFACE__
34687 - name: l3-interface-ipv6-address
34689 description: IP address
34692 example: __L3-INTERFACE-IPV6-ADDRESS__
34695 description: Name of VNF.
34700 description: Alternate name of VNF.
34705 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.
34710 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
34713 - name: regional-resource-zone
34715 description: Regional way of organizing pservers, source of truth should define values
34718 - name: prov-status
34720 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34723 - name: heat-stack-id
34725 description: Heat stack id corresponding to this instance, managed by MSO
34732 - name: is-closed-loop-disabled
34736 - name: model-invariant-id
34738 description: the ASDC model id for this resource or service model.
34741 - name: model-version-id
34743 description: the ASDC model version for this resource or service model.
34746 - name: widget-model-id
34748 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34751 - name: widget-model-version
34753 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34758 description: Generic description of the type of NF
34761 - name: nf-function
34763 description: English description of Network function that the specific VNF deployment is providing
34768 description: role in the network that this model will be providing
34771 - name: nf-naming-code
34773 description: string assigned to this model used for naming purposes
34776 - name: interface-id
34778 description: ID of interface
34783 description: MAC address for the interface
34786 - name: network-name
34788 description: Name of the network
34791 - name: vlan-id-inner
34793 description: Inner VLAN tag
34799 description: This indicates the customers VPN ID associated with this vlan
34802 - name: vlan-id-inner
34804 description: Inner VLAN tag
34808 - name: neutron-network-id
34810 description: Neutron network id of the interface that address belongs to
34813 - name: neutron-subnet-id
34815 description: Neutron id of subnet that address belongs to
34821 summary: create or update an existing l3-interface-ipv6-address-list
34823 Create or update an existing l3-interface-ipv6-address-list.
34825 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34826 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34835 description: Response codes found in [response codes](https://wiki.onap.org/).
34839 description: Unique id of VNF. This is unique across the graph.
34842 example: __VNF-ID__
34843 - name: interface-name
34845 description: Name given to the interface
34848 example: __INTERFACE-NAME__
34849 - name: vlan-interface
34851 description: String that identifies the interface
34854 example: __VLAN-INTERFACE__
34855 - name: l3-interface-ipv6-address
34857 description: IP address
34860 example: __L3-INTERFACE-IPV6-ADDRESS__
34863 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34866 $ref: "#/definitions/l3-interface-ipv6-address-list"
34870 summary: update an existing l3-interface-ipv6-address-list
34872 Update an existing l3-interface-ipv6-address-list
34874 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34875 The PUT operation will entirely replace an existing object.
34876 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34878 Other differences between PUT and PATCH are:
34880 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34881 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34882 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34883 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34892 description: Response codes found in [response codes](https://wiki.onap.org/).
34896 description: Unique id of VNF. This is unique across the graph.
34899 example: __VNF-ID__
34900 - name: interface-name
34902 description: Name given to the interface
34905 example: __INTERFACE-NAME__
34906 - name: vlan-interface
34908 description: String that identifies the interface
34911 example: __VLAN-INTERFACE__
34912 - name: l3-interface-ipv6-address
34914 description: IP address
34917 example: __L3-INTERFACE-IPV6-ADDRESS__
34920 description: l3-interface-ipv6-address-list object that needs to be created or updated.
34923 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34927 summary: delete an existing l3-interface-ipv6-address-list
34928 description: delete an existing l3-interface-ipv6-address-list
34929 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34938 description: Response codes found in [response codes](https://wiki.onap.org/).
34942 description: Unique id of VNF. This is unique across the graph.
34945 example: __VNF-ID__
34946 - name: interface-name
34948 description: Name given to the interface
34951 example: __INTERFACE-NAME__
34952 - name: vlan-interface
34954 description: String that identifies the interface
34957 example: __VLAN-INTERFACE__
34958 - name: l3-interface-ipv6-address
34960 description: IP address
34963 example: __L3-INTERFACE-IPV6-ADDRESS__
34964 - name: resource-version
34966 description: resource-version for concurrency
34969 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
34973 summary: returns vlan
34974 description: returns vlan
34975 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
34981 description: successful operation
34983 $ref: "#/getDefinitions/vlan"
34985 description: Response codes found in [response codes](https://wiki.onap.org/).
34989 description: Unique id of VNF. This is unique across the graph.
34992 example: __VNF-ID__
34993 - name: interface-name
34995 description: Name given to the interface
34998 example: __INTERFACE-NAME__
34999 - name: vlan-interface
35001 description: String that identifies the interface
35004 example: __VLAN-INTERFACE__
35007 description: Name of VNF.
35012 description: Alternate name of VNF.
35017 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.
35022 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35025 - name: regional-resource-zone
35027 description: Regional way of organizing pservers, source of truth should define values
35030 - name: prov-status
35032 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35035 - name: heat-stack-id
35037 description: Heat stack id corresponding to this instance, managed by MSO
35044 - name: is-closed-loop-disabled
35048 - name: model-invariant-id
35050 description: the ASDC model id for this resource or service model.
35053 - name: model-version-id
35055 description: the ASDC model version for this resource or service model.
35058 - name: widget-model-id
35060 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35063 - name: widget-model-version
35065 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35070 description: Generic description of the type of NF
35073 - name: nf-function
35075 description: English description of Network function that the specific VNF deployment is providing
35080 description: role in the network that this model will be providing
35083 - name: nf-naming-code
35085 description: string assigned to this model used for naming purposes
35088 - name: interface-id
35090 description: ID of interface
35095 description: MAC address for the interface
35098 - name: network-name
35100 description: Name of the network
35103 - name: vlan-id-inner
35105 description: Inner VLAN tag
35111 description: This indicates the customers VPN ID associated with this vlan
35117 summary: create or update an existing vlan
35119 Create or update an existing vlan.
35121 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35122 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35131 description: Response codes found in [response codes](https://wiki.onap.org/).
35135 description: Unique id of VNF. This is unique across the graph.
35138 example: __VNF-ID__
35139 - name: interface-name
35141 description: Name given to the interface
35144 example: __INTERFACE-NAME__
35145 - name: vlan-interface
35147 description: String that identifies the interface
35150 example: __VLAN-INTERFACE__
35153 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
35156 $ref: "#/definitions/vlan"
35160 summary: update an existing vlan
35162 Update an existing vlan
35164 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35165 The PUT operation will entirely replace an existing object.
35166 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35168 Other differences between PUT and PATCH are:
35170 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35171 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35172 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35173 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35182 description: Response codes found in [response codes](https://wiki.onap.org/).
35186 description: Unique id of VNF. This is unique across the graph.
35189 example: __VNF-ID__
35190 - name: interface-name
35192 description: Name given to the interface
35195 example: __INTERFACE-NAME__
35196 - name: vlan-interface
35198 description: String that identifies the interface
35201 example: __VLAN-INTERFACE__
35204 description: vlan object that needs to be created or updated.
35207 $ref: "#/patchDefinitions/vlan"
35211 summary: delete an existing vlan
35212 description: delete an existing vlan
35213 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35222 description: Response codes found in [response codes](https://wiki.onap.org/).
35226 description: Unique id of VNF. This is unique across the graph.
35229 example: __VNF-ID__
35230 - name: interface-name
35232 description: Name given to the interface
35235 example: __INTERFACE-NAME__
35236 - name: vlan-interface
35238 description: String that identifies the interface
35241 example: __VLAN-INTERFACE__
35242 - name: resource-version
35244 description: resource-version for concurrency
35247 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
35251 summary: returns vlans
35252 description: returns vlans
35253 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
35259 description: successful operation
35261 $ref: "#/getDefinitions/vlans"
35263 description: Response codes found in [response codes](https://wiki.onap.org/).
35267 description: Unique id of VNF. This is unique across the graph.
35270 example: __VNF-ID__
35271 - name: interface-name
35273 description: Name given to the interface
35276 example: __INTERFACE-NAME__
35279 description: Name of VNF.
35284 description: Alternate name of VNF.
35289 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.
35294 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35297 - name: regional-resource-zone
35299 description: Regional way of organizing pservers, source of truth should define values
35302 - name: prov-status
35304 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35307 - name: heat-stack-id
35309 description: Heat stack id corresponding to this instance, managed by MSO
35316 - name: is-closed-loop-disabled
35320 - name: model-invariant-id
35322 description: the ASDC model id for this resource or service model.
35325 - name: model-version-id
35327 description: the ASDC model version for this resource or service model.
35330 - name: widget-model-id
35332 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35335 - name: widget-model-version
35337 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35342 description: Generic description of the type of NF
35345 - name: nf-function
35347 description: English description of Network function that the specific VNF deployment is providing
35352 description: role in the network that this model will be providing
35355 - name: nf-naming-code
35357 description: string assigned to this model used for naming purposes
35360 - name: interface-id
35362 description: ID of interface
35367 description: MAC address for the interface
35370 - name: network-name
35372 description: Name of the network
35375 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
35379 summary: see node definition for valid relationships
35380 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35389 description: Response codes found in [response codes](https://wiki.onap.org/).
35393 description: Unique id of VNF. This is unique across the graph.
35396 example: __VNF-ID__
35397 - name: interface-name
35399 description: Name given to the interface
35402 example: __INTERFACE-NAME__
35405 description: PCI ID used to identify the sriov-vf
35408 example: __PCI-ID__
35411 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
35414 $ref: "#/definitions/relationship"
35418 summary: delete an existing relationship
35419 description: delete an existing relationship
35420 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35429 description: Response codes found in [response codes](https://wiki.onap.org/).
35433 description: Unique id of VNF. This is unique across the graph.
35436 example: __VNF-ID__
35437 - name: interface-name
35439 description: Name given to the interface
35442 example: __INTERFACE-NAME__
35445 description: PCI ID used to identify the sriov-vf
35448 example: __PCI-ID__
35449 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
35453 summary: returns sriov-vf
35454 description: returns sriov-vf
35455 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35461 description: successful operation
35463 $ref: "#/getDefinitions/sriov-vf"
35465 description: Response codes found in [response codes](https://wiki.onap.org/).
35469 description: Unique id of VNF. This is unique across the graph.
35472 example: __VNF-ID__
35473 - name: interface-name
35475 description: Name given to the interface
35478 example: __INTERFACE-NAME__
35481 description: PCI ID used to identify the sriov-vf
35484 example: __PCI-ID__
35487 description: Name of VNF.
35492 description: Alternate name of VNF.
35497 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.
35502 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35505 - name: regional-resource-zone
35507 description: Regional way of organizing pservers, source of truth should define values
35510 - name: prov-status
35512 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35515 - name: heat-stack-id
35517 description: Heat stack id corresponding to this instance, managed by MSO
35524 - name: is-closed-loop-disabled
35528 - name: model-invariant-id
35530 description: the ASDC model id for this resource or service model.
35533 - name: model-version-id
35535 description: the ASDC model version for this resource or service model.
35538 - name: widget-model-id
35540 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35543 - name: widget-model-version
35545 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35550 description: Generic description of the type of NF
35553 - name: nf-function
35555 description: English description of Network function that the specific VNF deployment is providing
35560 description: role in the network that this model will be providing
35563 - name: nf-naming-code
35565 description: string assigned to this model used for naming purposes
35568 - name: interface-id
35570 description: ID of interface
35575 description: MAC address for the interface
35578 - name: network-name
35580 description: Name of the network
35583 - name: vf-vlan-filter
35585 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
35588 - name: vf-mac-filter
35590 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
35593 - name: vf-vlan-strip
35595 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
35598 - name: neutron-network-id
35600 description: Neutron network id of the interface
35606 summary: create or update an existing sriov-vf
35608 Create or update an existing sriov-vf.
35610 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35611 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35620 description: Response codes found in [response codes](https://wiki.onap.org/).
35624 description: Unique id of VNF. This is unique across the graph.
35627 example: __VNF-ID__
35628 - name: interface-name
35630 description: Name given to the interface
35633 example: __INTERFACE-NAME__
35636 description: PCI ID used to identify the sriov-vf
35639 example: __PCI-ID__
35642 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
35645 $ref: "#/definitions/sriov-vf"
35649 summary: update an existing sriov-vf
35651 Update an existing sriov-vf
35653 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35654 The PUT operation will entirely replace an existing object.
35655 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35657 Other differences between PUT and PATCH are:
35659 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35660 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35661 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35662 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35671 description: Response codes found in [response codes](https://wiki.onap.org/).
35675 description: Unique id of VNF. This is unique across the graph.
35678 example: __VNF-ID__
35679 - name: interface-name
35681 description: Name given to the interface
35684 example: __INTERFACE-NAME__
35687 description: PCI ID used to identify the sriov-vf
35690 example: __PCI-ID__
35693 description: sriov-vf object that needs to be created or updated.
35696 $ref: "#/patchDefinitions/sriov-vf"
35700 summary: delete an existing sriov-vf
35701 description: delete an existing sriov-vf
35702 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35711 description: Response codes found in [response codes](https://wiki.onap.org/).
35715 description: Unique id of VNF. This is unique across the graph.
35718 example: __VNF-ID__
35719 - name: interface-name
35721 description: Name given to the interface
35724 example: __INTERFACE-NAME__
35727 description: PCI ID used to identify the sriov-vf
35730 example: __PCI-ID__
35731 - name: resource-version
35733 description: resource-version for concurrency
35736 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
35740 summary: returns sriov-vfs
35741 description: returns sriov-vfs
35742 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
35748 description: successful operation
35750 $ref: "#/getDefinitions/sriov-vfs"
35752 description: Response codes found in [response codes](https://wiki.onap.org/).
35756 description: Unique id of VNF. This is unique across the graph.
35759 example: __VNF-ID__
35760 - name: interface-name
35762 description: Name given to the interface
35765 example: __INTERFACE-NAME__
35768 description: Name of VNF.
35773 description: Alternate name of VNF.
35778 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.
35783 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35786 - name: regional-resource-zone
35788 description: Regional way of organizing pservers, source of truth should define values
35791 - name: prov-status
35793 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35796 - name: heat-stack-id
35798 description: Heat stack id corresponding to this instance, managed by MSO
35805 - name: is-closed-loop-disabled
35809 - name: model-invariant-id
35811 description: the ASDC model id for this resource or service model.
35814 - name: model-version-id
35816 description: the ASDC model version for this resource or service model.
35819 - name: widget-model-id
35821 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35824 - name: widget-model-version
35826 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35831 description: Generic description of the type of NF
35834 - name: nf-function
35836 description: English description of Network function that the specific VNF deployment is providing
35841 description: role in the network that this model will be providing
35844 - name: nf-naming-code
35846 description: string assigned to this model used for naming purposes
35849 - name: interface-id
35851 description: ID of interface
35856 description: MAC address for the interface
35859 - name: network-name
35861 description: Name of the network
35864 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
35868 summary: see node definition for valid relationships
35869 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
35878 description: Response codes found in [response codes](https://wiki.onap.org/).
35882 description: Unique id of VNF. This is unique across the graph.
35885 example: __VNF-ID__
35886 - name: interface-name
35888 description: Name given to the interface
35891 example: __INTERFACE-NAME__
35894 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
35897 $ref: "#/definitions/relationship"
35901 summary: delete an existing relationship
35902 description: delete an existing relationship
35903 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
35912 description: Response codes found in [response codes](https://wiki.onap.org/).
35916 description: Unique id of VNF. This is unique across the graph.
35919 example: __VNF-ID__
35920 - name: interface-name
35922 description: Name given to the interface
35925 example: __INTERFACE-NAME__
35926 /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:
35930 summary: see node definition for valid relationships
35931 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35940 description: Response codes found in [response codes](https://wiki.onap.org/).
35944 description: Unique id of VNF. This is unique across the graph.
35947 example: __VNF-ID__
35948 - name: interface-name
35950 description: Name given to the interface
35953 example: __INTERFACE-NAME__
35954 - name: l3-interface-ipv4-address
35956 description: IP address
35959 example: __L3-INTERFACE-IPV4-ADDRESS__
35962 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35965 $ref: "#/definitions/relationship"
35969 summary: delete an existing relationship
35970 description: delete an existing relationship
35971 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35980 description: Response codes found in [response codes](https://wiki.onap.org/).
35984 description: Unique id of VNF. This is unique across the graph.
35987 example: __VNF-ID__
35988 - name: interface-name
35990 description: Name given to the interface
35993 example: __INTERFACE-NAME__
35994 - name: l3-interface-ipv4-address
35996 description: IP address
35999 example: __L3-INTERFACE-IPV4-ADDRESS__
36000 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
36004 summary: returns l3-interface-ipv4-address-list
36005 description: returns l3-interface-ipv4-address-list
36006 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36012 description: successful operation
36014 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36016 description: Response codes found in [response codes](https://wiki.onap.org/).
36020 description: Unique id of VNF. This is unique across the graph.
36023 example: __VNF-ID__
36024 - name: interface-name
36026 description: Name given to the interface
36029 example: __INTERFACE-NAME__
36030 - name: l3-interface-ipv4-address
36032 description: IP address
36035 example: __L3-INTERFACE-IPV4-ADDRESS__
36038 description: Name of VNF.
36043 description: Alternate name of VNF.
36048 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.
36053 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36056 - name: regional-resource-zone
36058 description: Regional way of organizing pservers, source of truth should define values
36061 - name: prov-status
36063 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36066 - name: heat-stack-id
36068 description: Heat stack id corresponding to this instance, managed by MSO
36075 - name: is-closed-loop-disabled
36079 - name: model-invariant-id
36081 description: the ASDC model id for this resource or service model.
36084 - name: model-version-id
36086 description: the ASDC model version for this resource or service model.
36089 - name: widget-model-id
36091 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36094 - name: widget-model-version
36096 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36101 description: Generic description of the type of NF
36104 - name: nf-function
36106 description: English description of Network function that the specific VNF deployment is providing
36111 description: role in the network that this model will be providing
36114 - name: nf-naming-code
36116 description: string assigned to this model used for naming purposes
36119 - name: interface-id
36121 description: ID of interface
36126 description: MAC address for the interface
36129 - name: network-name
36131 description: Name of the network
36134 - name: vlan-id-inner
36136 description: Inner VLAN tag
36140 - name: neutron-network-id
36142 description: Neutron network id of the interface that address belongs to
36145 - name: neutron-subnet-id
36147 description: Neutron id of subnet that address belongs to
36153 summary: create or update an existing l3-interface-ipv4-address-list
36155 Create or update an existing l3-interface-ipv4-address-list.
36157 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36158 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36167 description: Response codes found in [response codes](https://wiki.onap.org/).
36171 description: Unique id of VNF. This is unique across the graph.
36174 example: __VNF-ID__
36175 - name: interface-name
36177 description: Name given to the interface
36180 example: __INTERFACE-NAME__
36181 - name: l3-interface-ipv4-address
36183 description: IP address
36186 example: __L3-INTERFACE-IPV4-ADDRESS__
36189 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36192 $ref: "#/definitions/l3-interface-ipv4-address-list"
36196 summary: update an existing l3-interface-ipv4-address-list
36198 Update an existing l3-interface-ipv4-address-list
36200 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36201 The PUT operation will entirely replace an existing object.
36202 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36204 Other differences between PUT and PATCH are:
36206 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36207 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36208 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36209 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36218 description: Response codes found in [response codes](https://wiki.onap.org/).
36222 description: Unique id of VNF. This is unique across the graph.
36225 example: __VNF-ID__
36226 - name: interface-name
36228 description: Name given to the interface
36231 example: __INTERFACE-NAME__
36232 - name: l3-interface-ipv4-address
36234 description: IP address
36237 example: __L3-INTERFACE-IPV4-ADDRESS__
36240 description: l3-interface-ipv4-address-list object that needs to be created or updated.
36243 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36247 summary: delete an existing l3-interface-ipv4-address-list
36248 description: delete an existing l3-interface-ipv4-address-list
36249 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36258 description: Response codes found in [response codes](https://wiki.onap.org/).
36262 description: Unique id of VNF. This is unique across the graph.
36265 example: __VNF-ID__
36266 - name: interface-name
36268 description: Name given to the interface
36271 example: __INTERFACE-NAME__
36272 - name: l3-interface-ipv4-address
36274 description: IP address
36277 example: __L3-INTERFACE-IPV4-ADDRESS__
36278 - name: resource-version
36280 description: resource-version for concurrency
36283 /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:
36287 summary: see node definition for valid relationships
36288 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36297 description: Response codes found in [response codes](https://wiki.onap.org/).
36301 description: Unique id of VNF. This is unique across the graph.
36304 example: __VNF-ID__
36305 - name: interface-name
36307 description: Name given to the interface
36310 example: __INTERFACE-NAME__
36311 - name: l3-interface-ipv6-address
36313 description: IP address
36316 example: __L3-INTERFACE-IPV6-ADDRESS__
36319 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36322 $ref: "#/definitions/relationship"
36326 summary: delete an existing relationship
36327 description: delete an existing relationship
36328 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36337 description: Response codes found in [response codes](https://wiki.onap.org/).
36341 description: Unique id of VNF. This is unique across the graph.
36344 example: __VNF-ID__
36345 - name: interface-name
36347 description: Name given to the interface
36350 example: __INTERFACE-NAME__
36351 - name: l3-interface-ipv6-address
36353 description: IP address
36356 example: __L3-INTERFACE-IPV6-ADDRESS__
36357 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
36361 summary: returns l3-interface-ipv6-address-list
36362 description: returns l3-interface-ipv6-address-list
36363 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36369 description: successful operation
36371 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36373 description: Response codes found in [response codes](https://wiki.onap.org/).
36377 description: Unique id of VNF. This is unique across the graph.
36380 example: __VNF-ID__
36381 - name: interface-name
36383 description: Name given to the interface
36386 example: __INTERFACE-NAME__
36387 - name: l3-interface-ipv6-address
36389 description: IP address
36392 example: __L3-INTERFACE-IPV6-ADDRESS__
36395 description: Name of VNF.
36400 description: Alternate name of VNF.
36405 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.
36410 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36413 - name: regional-resource-zone
36415 description: Regional way of organizing pservers, source of truth should define values
36418 - name: prov-status
36420 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36423 - name: heat-stack-id
36425 description: Heat stack id corresponding to this instance, managed by MSO
36432 - name: is-closed-loop-disabled
36436 - name: model-invariant-id
36438 description: the ASDC model id for this resource or service model.
36441 - name: model-version-id
36443 description: the ASDC model version for this resource or service model.
36446 - name: widget-model-id
36448 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36451 - name: widget-model-version
36453 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36458 description: Generic description of the type of NF
36461 - name: nf-function
36463 description: English description of Network function that the specific VNF deployment is providing
36468 description: role in the network that this model will be providing
36471 - name: nf-naming-code
36473 description: string assigned to this model used for naming purposes
36476 - name: interface-id
36478 description: ID of interface
36483 description: MAC address for the interface
36486 - name: network-name
36488 description: Name of the network
36491 - name: vlan-id-inner
36493 description: Inner VLAN tag
36497 - name: neutron-network-id
36499 description: Neutron network id of the interface that address belongs to
36502 - name: neutron-subnet-id
36504 description: Neutron id of subnet that address belongs to
36510 summary: create or update an existing l3-interface-ipv6-address-list
36512 Create or update an existing l3-interface-ipv6-address-list.
36514 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36515 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36524 description: Response codes found in [response codes](https://wiki.onap.org/).
36528 description: Unique id of VNF. This is unique across the graph.
36531 example: __VNF-ID__
36532 - name: interface-name
36534 description: Name given to the interface
36537 example: __INTERFACE-NAME__
36538 - name: l3-interface-ipv6-address
36540 description: IP address
36543 example: __L3-INTERFACE-IPV6-ADDRESS__
36546 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36549 $ref: "#/definitions/l3-interface-ipv6-address-list"
36553 summary: update an existing l3-interface-ipv6-address-list
36555 Update an existing l3-interface-ipv6-address-list
36557 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36558 The PUT operation will entirely replace an existing object.
36559 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36561 Other differences between PUT and PATCH are:
36563 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36564 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36565 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36566 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36575 description: Response codes found in [response codes](https://wiki.onap.org/).
36579 description: Unique id of VNF. This is unique across the graph.
36582 example: __VNF-ID__
36583 - name: interface-name
36585 description: Name given to the interface
36588 example: __INTERFACE-NAME__
36589 - name: l3-interface-ipv6-address
36591 description: IP address
36594 example: __L3-INTERFACE-IPV6-ADDRESS__
36597 description: l3-interface-ipv6-address-list object that needs to be created or updated.
36600 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36604 summary: delete an existing l3-interface-ipv6-address-list
36605 description: delete an existing l3-interface-ipv6-address-list
36606 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36615 description: Response codes found in [response codes](https://wiki.onap.org/).
36619 description: Unique id of VNF. This is unique across the graph.
36622 example: __VNF-ID__
36623 - name: interface-name
36625 description: Name given to the interface
36628 example: __INTERFACE-NAME__
36629 - name: l3-interface-ipv6-address
36631 description: IP address
36634 example: __L3-INTERFACE-IPV6-ADDRESS__
36635 - name: resource-version
36637 description: resource-version for concurrency
36640 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
36644 summary: returns l-interface
36645 description: returns l-interface
36646 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
36652 description: successful operation
36654 $ref: "#/getDefinitions/l-interface"
36656 description: Response codes found in [response codes](https://wiki.onap.org/).
36660 description: Unique id of VNF. This is unique across the graph.
36663 example: __VNF-ID__
36664 - name: interface-name
36666 description: Name given to the interface
36669 example: __INTERFACE-NAME__
36672 description: Name of VNF.
36677 description: Alternate name of VNF.
36682 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.
36687 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36690 - name: regional-resource-zone
36692 description: Regional way of organizing pservers, source of truth should define values
36695 - name: prov-status
36697 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36700 - name: heat-stack-id
36702 description: Heat stack id corresponding to this instance, managed by MSO
36709 - name: is-closed-loop-disabled
36713 - name: model-invariant-id
36715 description: the ASDC model id for this resource or service model.
36718 - name: model-version-id
36720 description: the ASDC model version for this resource or service model.
36723 - name: widget-model-id
36725 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36728 - name: widget-model-version
36730 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36735 description: Generic description of the type of NF
36738 - name: nf-function
36740 description: English description of Network function that the specific VNF deployment is providing
36745 description: role in the network that this model will be providing
36748 - name: nf-naming-code
36750 description: string assigned to this model used for naming purposes
36753 - name: interface-id
36755 description: ID of interface
36760 description: MAC address for the interface
36763 - name: network-name
36765 description: Name of the network
36771 summary: create or update an existing l-interface
36773 Create or update an existing l-interface.
36775 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36776 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
36785 description: Response codes found in [response codes](https://wiki.onap.org/).
36789 description: Unique id of VNF. This is unique across the graph.
36792 example: __VNF-ID__
36793 - name: interface-name
36795 description: Name given to the interface
36798 example: __INTERFACE-NAME__
36801 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
36804 $ref: "#/definitions/l-interface"
36808 summary: update an existing l-interface
36810 Update an existing l-interface
36812 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36813 The PUT operation will entirely replace an existing object.
36814 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36816 Other differences between PUT and PATCH are:
36818 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36819 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36820 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36821 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
36830 description: Response codes found in [response codes](https://wiki.onap.org/).
36834 description: Unique id of VNF. This is unique across the graph.
36837 example: __VNF-ID__
36838 - name: interface-name
36840 description: Name given to the interface
36843 example: __INTERFACE-NAME__
36846 description: l-interface object that needs to be created or updated.
36849 $ref: "#/patchDefinitions/l-interface"
36853 summary: delete an existing l-interface
36854 description: delete an existing l-interface
36855 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
36864 description: Response codes found in [response codes](https://wiki.onap.org/).
36868 description: Unique id of VNF. This is unique across the graph.
36871 example: __VNF-ID__
36872 - name: interface-name
36874 description: Name given to the interface
36877 example: __INTERFACE-NAME__
36878 - name: resource-version
36880 description: resource-version for concurrency
36883 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
36887 summary: returns l-interfaces
36888 description: returns l-interfaces
36889 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
36895 description: successful operation
36897 $ref: "#/getDefinitions/l-interfaces"
36899 description: Response codes found in [response codes](https://wiki.onap.org/).
36903 description: Unique id of VNF. This is unique across the graph.
36906 example: __VNF-ID__
36909 description: Name of VNF.
36914 description: Alternate name of VNF.
36919 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.
36924 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36927 - name: regional-resource-zone
36929 description: Regional way of organizing pservers, source of truth should define values
36932 - name: prov-status
36934 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36937 - name: heat-stack-id
36939 description: Heat stack id corresponding to this instance, managed by MSO
36946 - name: is-closed-loop-disabled
36950 - name: model-invariant-id
36952 description: the ASDC model id for this resource or service model.
36955 - name: model-version-id
36957 description: the ASDC model version for this resource or service model.
36960 - name: widget-model-id
36962 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36965 - name: widget-model-version
36967 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36972 description: Generic description of the type of NF
36975 - name: nf-function
36977 description: English description of Network function that the specific VNF deployment is providing
36982 description: role in the network that this model will be providing
36985 - name: nf-naming-code
36987 description: string assigned to this model used for naming purposes
36990 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
36994 summary: see node definition for valid relationships
36995 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
37004 description: Response codes found in [response codes](https://wiki.onap.org/).
37008 description: Unique id of VNF. This is unique across the graph.
37011 example: __VNF-ID__
37012 - name: interface-name
37014 description: Name that identifies the link aggregate interface
37017 example: __INTERFACE-NAME__
37020 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
37023 $ref: "#/definitions/relationship"
37027 summary: delete an existing relationship
37028 description: delete an existing relationship
37029 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
37038 description: Response codes found in [response codes](https://wiki.onap.org/).
37042 description: Unique id of VNF. This is unique across the graph.
37045 example: __VNF-ID__
37046 - name: interface-name
37048 description: Name that identifies the link aggregate interface
37051 example: __INTERFACE-NAME__
37052 /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:
37056 summary: see node definition for valid relationships
37057 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37066 description: Response codes found in [response codes](https://wiki.onap.org/).
37070 description: Unique id of VNF. This is unique across the graph.
37073 example: __VNF-ID__
37074 - name: interface-name
37076 description: Name that identifies the link aggregate interface
37079 example: __INTERFACE-NAME__
37080 - name: interface-name
37082 description: Name given to the interface
37085 example: __INTERFACE-NAME__
37086 - name: vlan-interface
37088 description: String that identifies the interface
37091 example: __VLAN-INTERFACE__
37094 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
37097 $ref: "#/definitions/relationship"
37101 summary: delete an existing relationship
37102 description: delete an existing relationship
37103 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37112 description: Response codes found in [response codes](https://wiki.onap.org/).
37116 description: Unique id of VNF. This is unique across the graph.
37119 example: __VNF-ID__
37120 - name: interface-name
37122 description: Name that identifies the link aggregate interface
37125 example: __INTERFACE-NAME__
37126 - name: interface-name
37128 description: Name given to the interface
37131 example: __INTERFACE-NAME__
37132 - name: vlan-interface
37134 description: String that identifies the interface
37137 example: __VLAN-INTERFACE__
37138 /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:
37142 summary: see node definition for valid relationships
37143 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37152 description: Response codes found in [response codes](https://wiki.onap.org/).
37156 description: Unique id of VNF. This is unique across the graph.
37159 example: __VNF-ID__
37160 - name: interface-name
37162 description: Name that identifies the link aggregate interface
37165 example: __INTERFACE-NAME__
37166 - name: interface-name
37168 description: Name given to the interface
37171 example: __INTERFACE-NAME__
37172 - name: vlan-interface
37174 description: String that identifies the interface
37177 example: __VLAN-INTERFACE__
37178 - name: l3-interface-ipv4-address
37180 description: IP address
37183 example: __L3-INTERFACE-IPV4-ADDRESS__
37186 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37189 $ref: "#/definitions/relationship"
37193 summary: delete an existing relationship
37194 description: delete an existing relationship
37195 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37204 description: Response codes found in [response codes](https://wiki.onap.org/).
37208 description: Unique id of VNF. This is unique across the graph.
37211 example: __VNF-ID__
37212 - name: interface-name
37214 description: Name that identifies the link aggregate interface
37217 example: __INTERFACE-NAME__
37218 - name: interface-name
37220 description: Name given to the interface
37223 example: __INTERFACE-NAME__
37224 - name: vlan-interface
37226 description: String that identifies the interface
37229 example: __VLAN-INTERFACE__
37230 - name: l3-interface-ipv4-address
37232 description: IP address
37235 example: __L3-INTERFACE-IPV4-ADDRESS__
37236 /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}:
37240 summary: returns l3-interface-ipv4-address-list
37241 description: returns l3-interface-ipv4-address-list
37242 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37248 description: successful operation
37250 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37252 description: Response codes found in [response codes](https://wiki.onap.org/).
37256 description: Unique id of VNF. This is unique across the graph.
37259 example: __VNF-ID__
37260 - name: interface-name
37262 description: Name that identifies the link aggregate interface
37265 example: __INTERFACE-NAME__
37266 - name: interface-name
37268 description: Name given to the interface
37271 example: __INTERFACE-NAME__
37272 - name: vlan-interface
37274 description: String that identifies the interface
37277 example: __VLAN-INTERFACE__
37278 - name: l3-interface-ipv4-address
37280 description: IP address
37283 example: __L3-INTERFACE-IPV4-ADDRESS__
37286 description: Name of VNF.
37291 description: Alternate name of VNF.
37296 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.
37301 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37304 - name: regional-resource-zone
37306 description: Regional way of organizing pservers, source of truth should define values
37309 - name: prov-status
37311 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37314 - name: heat-stack-id
37316 description: Heat stack id corresponding to this instance, managed by MSO
37323 - name: is-closed-loop-disabled
37327 - name: model-invariant-id
37329 description: the ASDC model id for this resource or service model.
37332 - name: model-version-id
37334 description: the ASDC model version for this resource or service model.
37337 - name: widget-model-id
37339 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37342 - name: widget-model-version
37344 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37349 description: Generic description of the type of NF
37352 - name: nf-function
37354 description: English description of Network function that the specific VNF deployment is providing
37359 description: role in the network that this model will be providing
37362 - name: nf-naming-code
37364 description: string assigned to this model used for naming purposes
37367 - name: interface-id
37369 description: ID of interface
37372 - name: interface-role
37374 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37377 - name: interface-id
37379 description: ID of interface
37384 description: MAC address for the interface
37387 - name: network-name
37389 description: Name of the network
37392 - name: vlan-id-inner
37394 description: Inner VLAN tag
37400 description: This indicates the customers VPN ID associated with this vlan
37403 - name: vlan-id-inner
37405 description: Inner VLAN tag
37409 - name: neutron-network-id
37411 description: Neutron network id of the interface that address belongs to
37414 - name: neutron-subnet-id
37416 description: Neutron id of subnet that address belongs to
37422 summary: create or update an existing l3-interface-ipv4-address-list
37424 Create or update an existing l3-interface-ipv4-address-list.
37426 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37427 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37436 description: Response codes found in [response codes](https://wiki.onap.org/).
37440 description: Unique id of VNF. This is unique across the graph.
37443 example: __VNF-ID__
37444 - name: interface-name
37446 description: Name that identifies the link aggregate interface
37449 example: __INTERFACE-NAME__
37450 - name: interface-name
37452 description: Name given to the interface
37455 example: __INTERFACE-NAME__
37456 - name: vlan-interface
37458 description: String that identifies the interface
37461 example: __VLAN-INTERFACE__
37462 - name: l3-interface-ipv4-address
37464 description: IP address
37467 example: __L3-INTERFACE-IPV4-ADDRESS__
37470 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37473 $ref: "#/definitions/l3-interface-ipv4-address-list"
37477 summary: update an existing l3-interface-ipv4-address-list
37479 Update an existing l3-interface-ipv4-address-list
37481 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37482 The PUT operation will entirely replace an existing object.
37483 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37485 Other differences between PUT and PATCH are:
37487 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37488 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37489 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37490 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37499 description: Response codes found in [response codes](https://wiki.onap.org/).
37503 description: Unique id of VNF. This is unique across the graph.
37506 example: __VNF-ID__
37507 - name: interface-name
37509 description: Name that identifies the link aggregate interface
37512 example: __INTERFACE-NAME__
37513 - name: interface-name
37515 description: Name given to the interface
37518 example: __INTERFACE-NAME__
37519 - name: vlan-interface
37521 description: String that identifies the interface
37524 example: __VLAN-INTERFACE__
37525 - name: l3-interface-ipv4-address
37527 description: IP address
37530 example: __L3-INTERFACE-IPV4-ADDRESS__
37533 description: l3-interface-ipv4-address-list object that needs to be created or updated.
37536 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37540 summary: delete an existing l3-interface-ipv4-address-list
37541 description: delete an existing l3-interface-ipv4-address-list
37542 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37551 description: Response codes found in [response codes](https://wiki.onap.org/).
37555 description: Unique id of VNF. This is unique across the graph.
37558 example: __VNF-ID__
37559 - name: interface-name
37561 description: Name that identifies the link aggregate interface
37564 example: __INTERFACE-NAME__
37565 - name: interface-name
37567 description: Name given to the interface
37570 example: __INTERFACE-NAME__
37571 - name: vlan-interface
37573 description: String that identifies the interface
37576 example: __VLAN-INTERFACE__
37577 - name: l3-interface-ipv4-address
37579 description: IP address
37582 example: __L3-INTERFACE-IPV4-ADDRESS__
37583 - name: resource-version
37585 description: resource-version for concurrency
37588 /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:
37592 summary: see node definition for valid relationships
37593 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37602 description: Response codes found in [response codes](https://wiki.onap.org/).
37606 description: Unique id of VNF. This is unique across the graph.
37609 example: __VNF-ID__
37610 - name: interface-name
37612 description: Name that identifies the link aggregate interface
37615 example: __INTERFACE-NAME__
37616 - name: interface-name
37618 description: Name given to the interface
37621 example: __INTERFACE-NAME__
37622 - name: vlan-interface
37624 description: String that identifies the interface
37627 example: __VLAN-INTERFACE__
37628 - name: l3-interface-ipv6-address
37630 description: IP address
37633 example: __L3-INTERFACE-IPV6-ADDRESS__
37636 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37639 $ref: "#/definitions/relationship"
37643 summary: delete an existing relationship
37644 description: delete an existing relationship
37645 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37654 description: Response codes found in [response codes](https://wiki.onap.org/).
37658 description: Unique id of VNF. This is unique across the graph.
37661 example: __VNF-ID__
37662 - name: interface-name
37664 description: Name that identifies the link aggregate interface
37667 example: __INTERFACE-NAME__
37668 - name: interface-name
37670 description: Name given to the interface
37673 example: __INTERFACE-NAME__
37674 - name: vlan-interface
37676 description: String that identifies the interface
37679 example: __VLAN-INTERFACE__
37680 - name: l3-interface-ipv6-address
37682 description: IP address
37685 example: __L3-INTERFACE-IPV6-ADDRESS__
37686 /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}:
37690 summary: returns l3-interface-ipv6-address-list
37691 description: returns l3-interface-ipv6-address-list
37692 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37698 description: successful operation
37700 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37702 description: Response codes found in [response codes](https://wiki.onap.org/).
37706 description: Unique id of VNF. This is unique across the graph.
37709 example: __VNF-ID__
37710 - name: interface-name
37712 description: Name that identifies the link aggregate interface
37715 example: __INTERFACE-NAME__
37716 - name: interface-name
37718 description: Name given to the interface
37721 example: __INTERFACE-NAME__
37722 - name: vlan-interface
37724 description: String that identifies the interface
37727 example: __VLAN-INTERFACE__
37728 - name: l3-interface-ipv6-address
37730 description: IP address
37733 example: __L3-INTERFACE-IPV6-ADDRESS__
37736 description: Name of VNF.
37741 description: Alternate name of VNF.
37746 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.
37751 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37754 - name: regional-resource-zone
37756 description: Regional way of organizing pservers, source of truth should define values
37759 - name: prov-status
37761 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37764 - name: heat-stack-id
37766 description: Heat stack id corresponding to this instance, managed by MSO
37773 - name: is-closed-loop-disabled
37777 - name: model-invariant-id
37779 description: the ASDC model id for this resource or service model.
37782 - name: model-version-id
37784 description: the ASDC model version for this resource or service model.
37787 - name: widget-model-id
37789 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37792 - name: widget-model-version
37794 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37799 description: Generic description of the type of NF
37802 - name: nf-function
37804 description: English description of Network function that the specific VNF deployment is providing
37809 description: role in the network that this model will be providing
37812 - name: nf-naming-code
37814 description: string assigned to this model used for naming purposes
37817 - name: interface-id
37819 description: ID of interface
37822 - name: interface-role
37824 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37827 - name: interface-id
37829 description: ID of interface
37834 description: MAC address for the interface
37837 - name: network-name
37839 description: Name of the network
37842 - name: vlan-id-inner
37844 description: Inner VLAN tag
37850 description: This indicates the customers VPN ID associated with this vlan
37853 - name: vlan-id-inner
37855 description: Inner VLAN tag
37859 - name: neutron-network-id
37861 description: Neutron network id of the interface that address belongs to
37864 - name: neutron-subnet-id
37866 description: Neutron id of subnet that address belongs to
37872 summary: create or update an existing l3-interface-ipv6-address-list
37874 Create or update an existing l3-interface-ipv6-address-list.
37876 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37877 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37886 description: Response codes found in [response codes](https://wiki.onap.org/).
37890 description: Unique id of VNF. This is unique across the graph.
37893 example: __VNF-ID__
37894 - name: interface-name
37896 description: Name that identifies the link aggregate interface
37899 example: __INTERFACE-NAME__
37900 - name: interface-name
37902 description: Name given to the interface
37905 example: __INTERFACE-NAME__
37906 - name: vlan-interface
37908 description: String that identifies the interface
37911 example: __VLAN-INTERFACE__
37912 - name: l3-interface-ipv6-address
37914 description: IP address
37917 example: __L3-INTERFACE-IPV6-ADDRESS__
37920 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37923 $ref: "#/definitions/l3-interface-ipv6-address-list"
37927 summary: update an existing l3-interface-ipv6-address-list
37929 Update an existing l3-interface-ipv6-address-list
37931 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37932 The PUT operation will entirely replace an existing object.
37933 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37935 Other differences between PUT and PATCH are:
37937 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37938 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37939 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37940 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37949 description: Response codes found in [response codes](https://wiki.onap.org/).
37953 description: Unique id of VNF. This is unique across the graph.
37956 example: __VNF-ID__
37957 - name: interface-name
37959 description: Name that identifies the link aggregate interface
37962 example: __INTERFACE-NAME__
37963 - name: interface-name
37965 description: Name given to the interface
37968 example: __INTERFACE-NAME__
37969 - name: vlan-interface
37971 description: String that identifies the interface
37974 example: __VLAN-INTERFACE__
37975 - name: l3-interface-ipv6-address
37977 description: IP address
37980 example: __L3-INTERFACE-IPV6-ADDRESS__
37983 description: l3-interface-ipv6-address-list object that needs to be created or updated.
37986 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37990 summary: delete an existing l3-interface-ipv6-address-list
37991 description: delete an existing l3-interface-ipv6-address-list
37992 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38001 description: Response codes found in [response codes](https://wiki.onap.org/).
38005 description: Unique id of VNF. This is unique across the graph.
38008 example: __VNF-ID__
38009 - name: interface-name
38011 description: Name that identifies the link aggregate interface
38014 example: __INTERFACE-NAME__
38015 - name: interface-name
38017 description: Name given to the interface
38020 example: __INTERFACE-NAME__
38021 - name: vlan-interface
38023 description: String that identifies the interface
38026 example: __VLAN-INTERFACE__
38027 - name: l3-interface-ipv6-address
38029 description: IP address
38032 example: __L3-INTERFACE-IPV6-ADDRESS__
38033 - name: resource-version
38035 description: resource-version for concurrency
38038 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
38042 summary: returns vlan
38043 description: returns vlan
38044 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38050 description: successful operation
38052 $ref: "#/getDefinitions/vlan"
38054 description: Response codes found in [response codes](https://wiki.onap.org/).
38058 description: Unique id of VNF. This is unique across the graph.
38061 example: __VNF-ID__
38062 - name: interface-name
38064 description: Name that identifies the link aggregate interface
38067 example: __INTERFACE-NAME__
38068 - name: interface-name
38070 description: Name given to the interface
38073 example: __INTERFACE-NAME__
38074 - name: vlan-interface
38076 description: String that identifies the interface
38079 example: __VLAN-INTERFACE__
38082 description: Name of VNF.
38087 description: Alternate name of VNF.
38092 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.
38097 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
38100 - name: regional-resource-zone
38102 description: Regional way of organizing pservers, source of truth should define values
38105 - name: prov-status
38107 description: Trigger for operational monitoring of this resource by Service Assurance systems.
38110 - name: heat-stack-id
38112 description: Heat stack id corresponding to this instance, managed by MSO
38119 - name: is-closed-loop-disabled
38123 - name: model-invariant-id
38125 description: the ASDC model id for this resource or service model.
38128 - name: model-version-id
38130 description: the ASDC model version for this resource or service model.
38133 - name: widget-model-id
38135 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38138 - name: widget-model-version
38140 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38145 description: Generic description of the type of NF
38148 - name: nf-function
38150 description: English description of Network function that the specific VNF deployment is providing
38155 description: role in the network that this model will be providing
38158 - name: nf-naming-code
38160 description: string assigned to this model used for naming purposes
38163 - name: interface-id
38165 description: ID of interface
38168 - name: interface-role
38170 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38173 - name: interface-id
38175 description: ID of interface
38180 description: MAC address for the interface
38183 - name: network-name
38185 description: Name of the network
38188 - name: vlan-id-inner
38190 description: Inner VLAN tag
38196 description: This indicates the customers VPN ID associated with this vlan
38202 summary: create or update an existing vlan
38204 Create or update an existing vlan.
38206 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38207 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38216 description: Response codes found in [response codes](https://wiki.onap.org/).
38220 description: Unique id of VNF. This is unique across the graph.
38223 example: __VNF-ID__
38224 - name: interface-name
38226 description: Name that identifies the link aggregate interface
38229 example: __INTERFACE-NAME__
38230 - name: interface-name
38232 description: Name given to the interface
38235 example: __INTERFACE-NAME__
38236 - name: vlan-interface
38238 description: String that identifies the interface
38241 example: __VLAN-INTERFACE__
38244 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
38247 $ref: "#/definitions/vlan"
38251 summary: update an existing vlan
38253 Update an existing vlan
38255 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38256 The PUT operation will entirely replace an existing object.
38257 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38259 Other differences between PUT and PATCH are:
38261 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38262 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38263 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38264 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38273 description: Response codes found in [response codes](https://wiki.onap.org/).
38277 description: Unique id of VNF. This is unique across the graph.
38280 example: __VNF-ID__
38281 - name: interface-name
38283 description: Name that identifies the link aggregate interface
38286 example: __INTERFACE-NAME__
38287 - name: interface-name
38289 description: Name given to the interface
38292 example: __INTERFACE-NAME__
38293 - name: vlan-interface
38295 description: String that identifies the interface
38298 example: __VLAN-INTERFACE__
38301 description: vlan object that needs to be created or updated.
38304 $ref: "#/patchDefinitions/vlan"
38308 summary: delete an existing vlan
38309 description: delete an existing vlan
38310 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38319 description: Response codes found in [response codes](https://wiki.onap.org/).
38323 description: Unique id of VNF. This is unique across the graph.
38326 example: __VNF-ID__
38327 - name: interface-name
38329 description: Name that identifies the link aggregate interface
38332 example: __INTERFACE-NAME__
38333 - name: interface-name
38335 description: Name given to the interface
38338 example: __INTERFACE-NAME__
38339 - name: vlan-interface
38341 description: String that identifies the interface
38344 example: __VLAN-INTERFACE__
38345 - name: resource-version
38347 description: resource-version for concurrency
38350 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
38354 summary: returns vlans
38355 description: returns vlans
38356 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
38362 description: successful operation
38364 $ref: "#/getDefinitions/vlans"
38366 description: Response codes found in [response codes](https://wiki.onap.org/).
38370 description: Unique id of VNF. This is unique across the graph.
38373 example: __VNF-ID__
38374 - name: interface-name
38376 description: Name that identifies the link aggregate interface
38379 example: __INTERFACE-NAME__
38380 - name: interface-name
38382 description: Name given to the interface
38385 example: __INTERFACE-NAME__
38388 description: Name of VNF.
38393 description: Alternate name of VNF.
38398 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.
38403 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
38406 - name: regional-resource-zone
38408 description: Regional way of organizing pservers, source of truth should define values
38411 - name: prov-status
38413 description: Trigger for operational monitoring of this resource by Service Assurance systems.
38416 - name: heat-stack-id
38418 description: Heat stack id corresponding to this instance, managed by MSO
38425 - name: is-closed-loop-disabled
38429 - name: model-invariant-id
38431 description: the ASDC model id for this resource or service model.
38434 - name: model-version-id
38436 description: the ASDC model version for this resource or service model.
38439 - name: widget-model-id
38441 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38444 - name: widget-model-version
38446 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38451 description: Generic description of the type of NF
38454 - name: nf-function
38456 description: English description of Network function that the specific VNF deployment is providing
38461 description: role in the network that this model will be providing
38464 - name: nf-naming-code
38466 description: string assigned to this model used for naming purposes
38469 - name: interface-id
38471 description: ID of interface
38474 - name: interface-role
38476 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38479 - name: interface-id
38481 description: ID of interface
38486 description: MAC address for the interface
38489 - name: network-name
38491 description: Name of the network
38494 /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:
38498 summary: see node definition for valid relationships
38499 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38508 description: Response codes found in [response codes](https://wiki.onap.org/).
38512 description: Unique id of VNF. This is unique across the graph.
38515 example: __VNF-ID__
38516 - name: interface-name
38518 description: Name that identifies the link aggregate interface
38521 example: __INTERFACE-NAME__
38522 - name: interface-name
38524 description: Name given to the interface
38527 example: __INTERFACE-NAME__
38530 description: PCI ID used to identify the sriov-vf
38533 example: __PCI-ID__
38536 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38539 $ref: "#/definitions/relationship"
38543 summary: delete an existing relationship
38544 description: delete an existing relationship
38545 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38554 description: Response codes found in [response codes](https://wiki.onap.org/).
38558 description: Unique id of VNF. This is unique across the graph.
38561 example: __VNF-ID__
38562 - name: interface-name
38564 description: Name that identifies the link aggregate interface
38567 example: __INTERFACE-NAME__
38568 - name: interface-name
38570 description: Name given to the interface
38573 example: __INTERFACE-NAME__
38576 description: PCI ID used to identify the sriov-vf
38579 example: __PCI-ID__
38580 /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}:
38584 summary: returns sriov-vf
38585 description: returns sriov-vf
38586 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38592 description: successful operation
38594 $ref: "#/getDefinitions/sriov-vf"
38596 description: Response codes found in [response codes](https://wiki.onap.org/).
38600 description: Unique id of VNF. This is unique across the graph.
38603 example: __VNF-ID__
38604 - name: interface-name
38606 description: Name that identifies the link aggregate interface
38609 example: __INTERFACE-NAME__
38610 - name: interface-name
38612 description: Name given to the interface
38615 example: __INTERFACE-NAME__
38618 description: PCI ID used to identify the sriov-vf
38621 example: __PCI-ID__
38624 description: Name of VNF.
38629 description: Alternate name of VNF.
38634 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.
38639 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
38642 - name: regional-resource-zone
38644 description: Regional way of organizing pservers, source of truth should define values
38647 - name: prov-status
38649 description: Trigger for operational monitoring of this resource by Service Assurance systems.
38652 - name: heat-stack-id
38654 description: Heat stack id corresponding to this instance, managed by MSO
38661 - name: is-closed-loop-disabled
38665 - name: model-invariant-id
38667 description: the ASDC model id for this resource or service model.
38670 - name: model-version-id
38672 description: the ASDC model version for this resource or service model.
38675 - name: widget-model-id
38677 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38680 - name: widget-model-version
38682 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38687 description: Generic description of the type of NF
38690 - name: nf-function
38692 description: English description of Network function that the specific VNF deployment is providing
38697 description: role in the network that this model will be providing
38700 - name: nf-naming-code
38702 description: string assigned to this model used for naming purposes
38705 - name: interface-id
38707 description: ID of interface
38710 - name: interface-role
38712 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38715 - name: interface-id
38717 description: ID of interface
38722 description: MAC address for the interface
38725 - name: network-name
38727 description: Name of the network
38730 - name: vf-vlan-filter
38732 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
38735 - name: vf-mac-filter
38737 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
38740 - name: vf-vlan-strip
38742 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
38745 - name: neutron-network-id
38747 description: Neutron network id of the interface
38753 summary: create or update an existing sriov-vf
38755 Create or update an existing sriov-vf.
38757 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38758 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38767 description: Response codes found in [response codes](https://wiki.onap.org/).
38771 description: Unique id of VNF. This is unique across the graph.
38774 example: __VNF-ID__
38775 - name: interface-name
38777 description: Name that identifies the link aggregate interface
38780 example: __INTERFACE-NAME__
38781 - name: interface-name
38783 description: Name given to the interface
38786 example: __INTERFACE-NAME__
38789 description: PCI ID used to identify the sriov-vf
38792 example: __PCI-ID__
38795 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38798 $ref: "#/definitions/sriov-vf"
38802 summary: update an existing sriov-vf
38804 Update an existing sriov-vf
38806 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38807 The PUT operation will entirely replace an existing object.
38808 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38810 Other differences between PUT and PATCH are:
38812 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38813 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38814 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38815 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38824 description: Response codes found in [response codes](https://wiki.onap.org/).
38828 description: Unique id of VNF. This is unique across the graph.
38831 example: __VNF-ID__
38832 - name: interface-name
38834 description: Name that identifies the link aggregate interface
38837 example: __INTERFACE-NAME__
38838 - name: interface-name
38840 description: Name given to the interface
38843 example: __INTERFACE-NAME__
38846 description: PCI ID used to identify the sriov-vf
38849 example: __PCI-ID__
38852 description: sriov-vf object that needs to be created or updated.
38855 $ref: "#/patchDefinitions/sriov-vf"
38859 summary: delete an existing sriov-vf
38860 description: delete an existing sriov-vf
38861 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38870 description: Response codes found in [response codes](https://wiki.onap.org/).
38874 description: Unique id of VNF. This is unique across the graph.
38877 example: __VNF-ID__
38878 - name: interface-name
38880 description: Name that identifies the link aggregate interface
38883 example: __INTERFACE-NAME__
38884 - name: interface-name
38886 description: Name given to the interface
38889 example: __INTERFACE-NAME__
38892 description: PCI ID used to identify the sriov-vf
38895 example: __PCI-ID__
38896 - name: resource-version
38898 description: resource-version for concurrency
38901 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38905 summary: returns sriov-vfs
38906 description: returns sriov-vfs
38907 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
38913 description: successful operation
38915 $ref: "#/getDefinitions/sriov-vfs"
38917 description: Response codes found in [response codes](https://wiki.onap.org/).
38921 description: Unique id of VNF. This is unique across the graph.
38924 example: __VNF-ID__
38925 - name: interface-name
38927 description: Name that identifies the link aggregate interface
38930 example: __INTERFACE-NAME__
38931 - name: interface-name
38933 description: Name given to the interface
38936 example: __INTERFACE-NAME__
38939 description: Name of VNF.
38944 description: Alternate name of VNF.
38949 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.
38954 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
38957 - name: regional-resource-zone
38959 description: Regional way of organizing pservers, source of truth should define values
38962 - name: prov-status
38964 description: Trigger for operational monitoring of this resource by Service Assurance systems.
38967 - name: heat-stack-id
38969 description: Heat stack id corresponding to this instance, managed by MSO
38976 - name: is-closed-loop-disabled
38980 - name: model-invariant-id
38982 description: the ASDC model id for this resource or service model.
38985 - name: model-version-id
38987 description: the ASDC model version for this resource or service model.
38990 - name: widget-model-id
38992 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38995 - name: widget-model-version
38997 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39002 description: Generic description of the type of NF
39005 - name: nf-function
39007 description: English description of Network function that the specific VNF deployment is providing
39012 description: role in the network that this model will be providing
39015 - name: nf-naming-code
39017 description: string assigned to this model used for naming purposes
39020 - name: interface-id
39022 description: ID of interface
39025 - name: interface-role
39027 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39030 - name: interface-id
39032 description: ID of interface
39037 description: MAC address for the interface
39040 - name: network-name
39042 description: Name of the network
39045 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
39049 summary: see node definition for valid relationships
39050 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
39059 description: Response codes found in [response codes](https://wiki.onap.org/).
39063 description: Unique id of VNF. This is unique across the graph.
39066 example: __VNF-ID__
39067 - name: interface-name
39069 description: Name that identifies the link aggregate interface
39072 example: __INTERFACE-NAME__
39073 - name: interface-name
39075 description: Name given to the interface
39078 example: __INTERFACE-NAME__
39081 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
39084 $ref: "#/definitions/relationship"
39088 summary: delete an existing relationship
39089 description: delete an existing relationship
39090 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
39099 description: Response codes found in [response codes](https://wiki.onap.org/).
39103 description: Unique id of VNF. This is unique across the graph.
39106 example: __VNF-ID__
39107 - name: interface-name
39109 description: Name that identifies the link aggregate interface
39112 example: __INTERFACE-NAME__
39113 - name: interface-name
39115 description: Name given to the interface
39118 example: __INTERFACE-NAME__
39119 /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:
39123 summary: see node definition for valid relationships
39124 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39133 description: Response codes found in [response codes](https://wiki.onap.org/).
39137 description: Unique id of VNF. This is unique across the graph.
39140 example: __VNF-ID__
39141 - name: interface-name
39143 description: Name that identifies the link aggregate interface
39146 example: __INTERFACE-NAME__
39147 - name: interface-name
39149 description: Name given to the interface
39152 example: __INTERFACE-NAME__
39153 - name: l3-interface-ipv4-address
39155 description: IP address
39158 example: __L3-INTERFACE-IPV4-ADDRESS__
39161 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39164 $ref: "#/definitions/relationship"
39168 summary: delete an existing relationship
39169 description: delete an existing relationship
39170 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39179 description: Response codes found in [response codes](https://wiki.onap.org/).
39183 description: Unique id of VNF. This is unique across the graph.
39186 example: __VNF-ID__
39187 - name: interface-name
39189 description: Name that identifies the link aggregate interface
39192 example: __INTERFACE-NAME__
39193 - name: interface-name
39195 description: Name given to the interface
39198 example: __INTERFACE-NAME__
39199 - name: l3-interface-ipv4-address
39201 description: IP address
39204 example: __L3-INTERFACE-IPV4-ADDRESS__
39205 /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}:
39209 summary: returns l3-interface-ipv4-address-list
39210 description: returns l3-interface-ipv4-address-list
39211 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39217 description: successful operation
39219 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39221 description: Response codes found in [response codes](https://wiki.onap.org/).
39225 description: Unique id of VNF. This is unique across the graph.
39228 example: __VNF-ID__
39229 - name: interface-name
39231 description: Name that identifies the link aggregate interface
39234 example: __INTERFACE-NAME__
39235 - name: interface-name
39237 description: Name given to the interface
39240 example: __INTERFACE-NAME__
39241 - name: l3-interface-ipv4-address
39243 description: IP address
39246 example: __L3-INTERFACE-IPV4-ADDRESS__
39249 description: Name of VNF.
39254 description: Alternate name of VNF.
39259 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.
39264 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
39267 - name: regional-resource-zone
39269 description: Regional way of organizing pservers, source of truth should define values
39272 - name: prov-status
39274 description: Trigger for operational monitoring of this resource by Service Assurance systems.
39277 - name: heat-stack-id
39279 description: Heat stack id corresponding to this instance, managed by MSO
39286 - name: is-closed-loop-disabled
39290 - name: model-invariant-id
39292 description: the ASDC model id for this resource or service model.
39295 - name: model-version-id
39297 description: the ASDC model version for this resource or service model.
39300 - name: widget-model-id
39302 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39305 - name: widget-model-version
39307 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39312 description: Generic description of the type of NF
39315 - name: nf-function
39317 description: English description of Network function that the specific VNF deployment is providing
39322 description: role in the network that this model will be providing
39325 - name: nf-naming-code
39327 description: string assigned to this model used for naming purposes
39330 - name: interface-id
39332 description: ID of interface
39335 - name: interface-role
39337 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39340 - name: interface-id
39342 description: ID of interface
39347 description: MAC address for the interface
39350 - name: network-name
39352 description: Name of the network
39355 - name: vlan-id-inner
39357 description: Inner VLAN tag
39361 - name: neutron-network-id
39363 description: Neutron network id of the interface that address belongs to
39366 - name: neutron-subnet-id
39368 description: Neutron id of subnet that address belongs to
39374 summary: create or update an existing l3-interface-ipv4-address-list
39376 Create or update an existing l3-interface-ipv4-address-list.
39378 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39379 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39388 description: Response codes found in [response codes](https://wiki.onap.org/).
39392 description: Unique id of VNF. This is unique across the graph.
39395 example: __VNF-ID__
39396 - name: interface-name
39398 description: Name that identifies the link aggregate interface
39401 example: __INTERFACE-NAME__
39402 - name: interface-name
39404 description: Name given to the interface
39407 example: __INTERFACE-NAME__
39408 - name: l3-interface-ipv4-address
39410 description: IP address
39413 example: __L3-INTERFACE-IPV4-ADDRESS__
39416 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39419 $ref: "#/definitions/l3-interface-ipv4-address-list"
39423 summary: update an existing l3-interface-ipv4-address-list
39425 Update an existing l3-interface-ipv4-address-list
39427 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39428 The PUT operation will entirely replace an existing object.
39429 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39431 Other differences between PUT and PATCH are:
39433 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39434 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39435 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39436 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39445 description: Response codes found in [response codes](https://wiki.onap.org/).
39449 description: Unique id of VNF. This is unique across the graph.
39452 example: __VNF-ID__
39453 - name: interface-name
39455 description: Name that identifies the link aggregate interface
39458 example: __INTERFACE-NAME__
39459 - name: interface-name
39461 description: Name given to the interface
39464 example: __INTERFACE-NAME__
39465 - name: l3-interface-ipv4-address
39467 description: IP address
39470 example: __L3-INTERFACE-IPV4-ADDRESS__
39473 description: l3-interface-ipv4-address-list object that needs to be created or updated.
39476 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39480 summary: delete an existing l3-interface-ipv4-address-list
39481 description: delete an existing l3-interface-ipv4-address-list
39482 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39491 description: Response codes found in [response codes](https://wiki.onap.org/).
39495 description: Unique id of VNF. This is unique across the graph.
39498 example: __VNF-ID__
39499 - name: interface-name
39501 description: Name that identifies the link aggregate interface
39504 example: __INTERFACE-NAME__
39505 - name: interface-name
39507 description: Name given to the interface
39510 example: __INTERFACE-NAME__
39511 - name: l3-interface-ipv4-address
39513 description: IP address
39516 example: __L3-INTERFACE-IPV4-ADDRESS__
39517 - name: resource-version
39519 description: resource-version for concurrency
39522 /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:
39526 summary: see node definition for valid relationships
39527 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39536 description: Response codes found in [response codes](https://wiki.onap.org/).
39540 description: Unique id of VNF. This is unique across the graph.
39543 example: __VNF-ID__
39544 - name: interface-name
39546 description: Name that identifies the link aggregate interface
39549 example: __INTERFACE-NAME__
39550 - name: interface-name
39552 description: Name given to the interface
39555 example: __INTERFACE-NAME__
39556 - name: l3-interface-ipv6-address
39558 description: IP address
39561 example: __L3-INTERFACE-IPV6-ADDRESS__
39564 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39567 $ref: "#/definitions/relationship"
39571 summary: delete an existing relationship
39572 description: delete an existing relationship
39573 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39582 description: Response codes found in [response codes](https://wiki.onap.org/).
39586 description: Unique id of VNF. This is unique across the graph.
39589 example: __VNF-ID__
39590 - name: interface-name
39592 description: Name that identifies the link aggregate interface
39595 example: __INTERFACE-NAME__
39596 - name: interface-name
39598 description: Name given to the interface
39601 example: __INTERFACE-NAME__
39602 - name: l3-interface-ipv6-address
39604 description: IP address
39607 example: __L3-INTERFACE-IPV6-ADDRESS__
39608 /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}:
39612 summary: returns l3-interface-ipv6-address-list
39613 description: returns l3-interface-ipv6-address-list
39614 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39620 description: successful operation
39622 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39624 description: Response codes found in [response codes](https://wiki.onap.org/).
39628 description: Unique id of VNF. This is unique across the graph.
39631 example: __VNF-ID__
39632 - name: interface-name
39634 description: Name that identifies the link aggregate interface
39637 example: __INTERFACE-NAME__
39638 - name: interface-name
39640 description: Name given to the interface
39643 example: __INTERFACE-NAME__
39644 - name: l3-interface-ipv6-address
39646 description: IP address
39649 example: __L3-INTERFACE-IPV6-ADDRESS__
39652 description: Name of VNF.
39657 description: Alternate name of VNF.
39662 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.
39667 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
39670 - name: regional-resource-zone
39672 description: Regional way of organizing pservers, source of truth should define values
39675 - name: prov-status
39677 description: Trigger for operational monitoring of this resource by Service Assurance systems.
39680 - name: heat-stack-id
39682 description: Heat stack id corresponding to this instance, managed by MSO
39689 - name: is-closed-loop-disabled
39693 - name: model-invariant-id
39695 description: the ASDC model id for this resource or service model.
39698 - name: model-version-id
39700 description: the ASDC model version for this resource or service model.
39703 - name: widget-model-id
39705 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39708 - name: widget-model-version
39710 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39715 description: Generic description of the type of NF
39718 - name: nf-function
39720 description: English description of Network function that the specific VNF deployment is providing
39725 description: role in the network that this model will be providing
39728 - name: nf-naming-code
39730 description: string assigned to this model used for naming purposes
39733 - name: interface-id
39735 description: ID of interface
39738 - name: interface-role
39740 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39743 - name: interface-id
39745 description: ID of interface
39750 description: MAC address for the interface
39753 - name: network-name
39755 description: Name of the network
39758 - name: vlan-id-inner
39760 description: Inner VLAN tag
39764 - name: neutron-network-id
39766 description: Neutron network id of the interface that address belongs to
39769 - name: neutron-subnet-id
39771 description: Neutron id of subnet that address belongs to
39777 summary: create or update an existing l3-interface-ipv6-address-list
39779 Create or update an existing l3-interface-ipv6-address-list.
39781 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39782 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39791 description: Response codes found in [response codes](https://wiki.onap.org/).
39795 description: Unique id of VNF. This is unique across the graph.
39798 example: __VNF-ID__
39799 - name: interface-name
39801 description: Name that identifies the link aggregate interface
39804 example: __INTERFACE-NAME__
39805 - name: interface-name
39807 description: Name given to the interface
39810 example: __INTERFACE-NAME__
39811 - name: l3-interface-ipv6-address
39813 description: IP address
39816 example: __L3-INTERFACE-IPV6-ADDRESS__
39819 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39822 $ref: "#/definitions/l3-interface-ipv6-address-list"
39826 summary: update an existing l3-interface-ipv6-address-list
39828 Update an existing l3-interface-ipv6-address-list
39830 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39831 The PUT operation will entirely replace an existing object.
39832 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39834 Other differences between PUT and PATCH are:
39836 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39837 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39838 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39839 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39848 description: Response codes found in [response codes](https://wiki.onap.org/).
39852 description: Unique id of VNF. This is unique across the graph.
39855 example: __VNF-ID__
39856 - name: interface-name
39858 description: Name that identifies the link aggregate interface
39861 example: __INTERFACE-NAME__
39862 - name: interface-name
39864 description: Name given to the interface
39867 example: __INTERFACE-NAME__
39868 - name: l3-interface-ipv6-address
39870 description: IP address
39873 example: __L3-INTERFACE-IPV6-ADDRESS__
39876 description: l3-interface-ipv6-address-list object that needs to be created or updated.
39879 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39883 summary: delete an existing l3-interface-ipv6-address-list
39884 description: delete an existing l3-interface-ipv6-address-list
39885 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39894 description: Response codes found in [response codes](https://wiki.onap.org/).
39898 description: Unique id of VNF. This is unique across the graph.
39901 example: __VNF-ID__
39902 - name: interface-name
39904 description: Name that identifies the link aggregate interface
39907 example: __INTERFACE-NAME__
39908 - name: interface-name
39910 description: Name given to the interface
39913 example: __INTERFACE-NAME__
39914 - name: l3-interface-ipv6-address
39916 description: IP address
39919 example: __L3-INTERFACE-IPV6-ADDRESS__
39920 - name: resource-version
39922 description: resource-version for concurrency
39925 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
39929 summary: returns l-interface
39930 description: returns l-interface
39931 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
39937 description: successful operation
39939 $ref: "#/getDefinitions/l-interface"
39941 description: Response codes found in [response codes](https://wiki.onap.org/).
39945 description: Unique id of VNF. This is unique across the graph.
39948 example: __VNF-ID__
39949 - name: interface-name
39951 description: Name that identifies the link aggregate interface
39954 example: __INTERFACE-NAME__
39955 - name: interface-name
39957 description: Name given to the interface
39960 example: __INTERFACE-NAME__
39963 description: Name of VNF.
39968 description: Alternate name of VNF.
39973 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.
39978 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
39981 - name: regional-resource-zone
39983 description: Regional way of organizing pservers, source of truth should define values
39986 - name: prov-status
39988 description: Trigger for operational monitoring of this resource by Service Assurance systems.
39991 - name: heat-stack-id
39993 description: Heat stack id corresponding to this instance, managed by MSO
40000 - name: is-closed-loop-disabled
40004 - name: model-invariant-id
40006 description: the ASDC model id for this resource or service model.
40009 - name: model-version-id
40011 description: the ASDC model version for this resource or service model.
40014 - name: widget-model-id
40016 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40019 - name: widget-model-version
40021 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40026 description: Generic description of the type of NF
40029 - name: nf-function
40031 description: English description of Network function that the specific VNF deployment is providing
40036 description: role in the network that this model will be providing
40039 - name: nf-naming-code
40041 description: string assigned to this model used for naming purposes
40044 - name: interface-id
40046 description: ID of interface
40049 - name: interface-role
40051 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40054 - name: interface-id
40056 description: ID of interface
40061 description: MAC address for the interface
40064 - name: network-name
40066 description: Name of the network
40072 summary: create or update an existing l-interface
40074 Create or update an existing l-interface.
40076 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40077 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40086 description: Response codes found in [response codes](https://wiki.onap.org/).
40090 description: Unique id of VNF. This is unique across the graph.
40093 example: __VNF-ID__
40094 - name: interface-name
40096 description: Name that identifies the link aggregate interface
40099 example: __INTERFACE-NAME__
40100 - name: interface-name
40102 description: Name given to the interface
40105 example: __INTERFACE-NAME__
40108 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
40111 $ref: "#/definitions/l-interface"
40115 summary: update an existing l-interface
40117 Update an existing l-interface
40119 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40120 The PUT operation will entirely replace an existing object.
40121 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40123 Other differences between PUT and PATCH are:
40125 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40126 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40127 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40128 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40137 description: Response codes found in [response codes](https://wiki.onap.org/).
40141 description: Unique id of VNF. This is unique across the graph.
40144 example: __VNF-ID__
40145 - name: interface-name
40147 description: Name that identifies the link aggregate interface
40150 example: __INTERFACE-NAME__
40151 - name: interface-name
40153 description: Name given to the interface
40156 example: __INTERFACE-NAME__
40159 description: l-interface object that needs to be created or updated.
40162 $ref: "#/patchDefinitions/l-interface"
40166 summary: delete an existing l-interface
40167 description: delete an existing l-interface
40168 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40177 description: Response codes found in [response codes](https://wiki.onap.org/).
40181 description: Unique id of VNF. This is unique across the graph.
40184 example: __VNF-ID__
40185 - name: interface-name
40187 description: Name that identifies the link aggregate interface
40190 example: __INTERFACE-NAME__
40191 - name: interface-name
40193 description: Name given to the interface
40196 example: __INTERFACE-NAME__
40197 - name: resource-version
40199 description: resource-version for concurrency
40202 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
40206 summary: returns l-interfaces
40207 description: returns l-interfaces
40208 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
40214 description: successful operation
40216 $ref: "#/getDefinitions/l-interfaces"
40218 description: Response codes found in [response codes](https://wiki.onap.org/).
40222 description: Unique id of VNF. This is unique across the graph.
40225 example: __VNF-ID__
40226 - name: interface-name
40228 description: Name that identifies the link aggregate interface
40231 example: __INTERFACE-NAME__
40234 description: Name of VNF.
40239 description: Alternate name of VNF.
40244 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.
40249 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
40252 - name: regional-resource-zone
40254 description: Regional way of organizing pservers, source of truth should define values
40257 - name: prov-status
40259 description: Trigger for operational monitoring of this resource by Service Assurance systems.
40262 - name: heat-stack-id
40264 description: Heat stack id corresponding to this instance, managed by MSO
40271 - name: is-closed-loop-disabled
40275 - name: model-invariant-id
40277 description: the ASDC model id for this resource or service model.
40280 - name: model-version-id
40282 description: the ASDC model version for this resource or service model.
40285 - name: widget-model-id
40287 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40290 - name: widget-model-version
40292 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40297 description: Generic description of the type of NF
40300 - name: nf-function
40302 description: English description of Network function that the specific VNF deployment is providing
40307 description: role in the network that this model will be providing
40310 - name: nf-naming-code
40312 description: string assigned to this model used for naming purposes
40315 - name: interface-id
40317 description: ID of interface
40320 - name: interface-role
40322 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40325 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
40329 summary: returns lag-interface
40330 description: returns lag-interface
40331 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40337 description: successful operation
40339 $ref: "#/getDefinitions/lag-interface"
40341 description: Response codes found in [response codes](https://wiki.onap.org/).
40345 description: Unique id of VNF. This is unique across the graph.
40348 example: __VNF-ID__
40349 - name: interface-name
40351 description: Name that identifies the link aggregate interface
40354 example: __INTERFACE-NAME__
40357 description: Name of VNF.
40362 description: Alternate name of VNF.
40367 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.
40372 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
40375 - name: regional-resource-zone
40377 description: Regional way of organizing pservers, source of truth should define values
40380 - name: prov-status
40382 description: Trigger for operational monitoring of this resource by Service Assurance systems.
40385 - name: heat-stack-id
40387 description: Heat stack id corresponding to this instance, managed by MSO
40394 - name: is-closed-loop-disabled
40398 - name: model-invariant-id
40400 description: the ASDC model id for this resource or service model.
40403 - name: model-version-id
40405 description: the ASDC model version for this resource or service model.
40408 - name: widget-model-id
40410 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40413 - name: widget-model-version
40415 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40420 description: Generic description of the type of NF
40423 - name: nf-function
40425 description: English description of Network function that the specific VNF deployment is providing
40430 description: role in the network that this model will be providing
40433 - name: nf-naming-code
40435 description: string assigned to this model used for naming purposes
40438 - name: interface-id
40440 description: ID of interface
40443 - name: interface-role
40445 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40451 summary: create or update an existing lag-interface
40453 Create or update an existing lag-interface.
40455 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40456 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40465 description: Response codes found in [response codes](https://wiki.onap.org/).
40469 description: Unique id of VNF. This is unique across the graph.
40472 example: __VNF-ID__
40473 - name: interface-name
40475 description: Name that identifies the link aggregate interface
40478 example: __INTERFACE-NAME__
40481 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
40484 $ref: "#/definitions/lag-interface"
40488 summary: update an existing lag-interface
40490 Update an existing lag-interface
40492 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40493 The PUT operation will entirely replace an existing object.
40494 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40496 Other differences between PUT and PATCH are:
40498 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40499 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40500 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40501 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40510 description: Response codes found in [response codes](https://wiki.onap.org/).
40514 description: Unique id of VNF. This is unique across the graph.
40517 example: __VNF-ID__
40518 - name: interface-name
40520 description: Name that identifies the link aggregate interface
40523 example: __INTERFACE-NAME__
40526 description: lag-interface object that needs to be created or updated.
40529 $ref: "#/patchDefinitions/lag-interface"
40533 summary: delete an existing lag-interface
40534 description: delete an existing lag-interface
40535 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40544 description: Response codes found in [response codes](https://wiki.onap.org/).
40548 description: Unique id of VNF. This is unique across the graph.
40551 example: __VNF-ID__
40552 - name: interface-name
40554 description: Name that identifies the link aggregate interface
40557 example: __INTERFACE-NAME__
40558 - name: resource-version
40560 description: resource-version for concurrency
40563 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
40567 summary: returns lag-interfaces
40568 description: returns lag-interfaces
40569 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
40575 description: successful operation
40577 $ref: "#/getDefinitions/lag-interfaces"
40579 description: Response codes found in [response codes](https://wiki.onap.org/).
40583 description: Unique id of VNF. This is unique across the graph.
40586 example: __VNF-ID__
40589 description: Name of VNF.
40594 description: Alternate name of VNF.
40599 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.
40604 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
40607 - name: regional-resource-zone
40609 description: Regional way of organizing pservers, source of truth should define values
40612 - name: prov-status
40614 description: Trigger for operational monitoring of this resource by Service Assurance systems.
40617 - name: heat-stack-id
40619 description: Heat stack id corresponding to this instance, managed by MSO
40626 - name: is-closed-loop-disabled
40630 - name: model-invariant-id
40632 description: the ASDC model id for this resource or service model.
40635 - name: model-version-id
40637 description: the ASDC model version for this resource or service model.
40640 - name: widget-model-id
40642 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40645 - name: widget-model-version
40647 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40652 description: Generic description of the type of NF
40655 - name: nf-function
40657 description: English description of Network function that the specific VNF deployment is providing
40662 description: role in the network that this model will be providing
40665 - name: nf-naming-code
40667 description: string assigned to this model used for naming purposes
40670 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
40674 summary: see node definition for valid relationships
40675 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
40684 description: Response codes found in [response codes](https://wiki.onap.org/).
40688 description: Unique id of VNF. This is unique across the graph.
40691 example: __VNF-ID__
40692 - name: vf-module-id
40694 description: Unique ID of vf-module.
40697 example: __VF-MODULE-ID__
40700 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
40703 $ref: "#/definitions/relationship"
40707 summary: delete an existing relationship
40708 description: delete an existing relationship
40709 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
40718 description: Response codes found in [response codes](https://wiki.onap.org/).
40722 description: Unique id of VNF. This is unique across the graph.
40725 example: __VNF-ID__
40726 - name: vf-module-id
40728 description: Unique ID of vf-module.
40731 example: __VF-MODULE-ID__
40732 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
40736 summary: returns vf-module
40737 description: returns vf-module
40738 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
40744 description: successful operation
40746 $ref: "#/getDefinitions/vf-module"
40748 description: Response codes found in [response codes](https://wiki.onap.org/).
40752 description: Unique id of VNF. This is unique across the graph.
40755 example: __VNF-ID__
40756 - name: vf-module-id
40758 description: Unique ID of vf-module.
40761 example: __VF-MODULE-ID__
40764 description: Name of VNF.
40769 description: Alternate name of VNF.
40774 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.
40779 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
40782 - name: regional-resource-zone
40784 description: Regional way of organizing pservers, source of truth should define values
40787 - name: prov-status
40789 description: Trigger for operational monitoring of this resource by Service Assurance systems.
40792 - name: heat-stack-id
40794 description: Heat stack id corresponding to this instance, managed by MSO
40801 - name: is-closed-loop-disabled
40805 - name: model-invariant-id
40807 description: the ASDC model id for this resource or service model.
40810 - name: model-version-id
40812 description: the ASDC model version for this resource or service model.
40815 - name: widget-model-id
40817 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40820 - name: widget-model-version
40822 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40827 description: Generic description of the type of NF
40830 - name: nf-function
40832 description: English description of Network function that the specific VNF deployment is providing
40837 description: role in the network that this model will be providing
40840 - name: nf-naming-code
40842 description: string assigned to this model used for naming purposes
40845 - name: vf-module-name
40847 description: Name of vf-module
40850 - name: heat-stack-id
40852 description: Heat stack id corresponding to this instance.
40855 - name: model-invariant-id
40857 description: the ASDC model id for this resource or service model.
40860 - name: model-version-id
40862 description: the ASDC model version for this resource or service model.
40865 - name: widget-model-id
40867 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40870 - name: widget-model-version
40872 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40875 - name: contrail-service-instance-fqdn
40877 description: the Contrail unique ID for a service-instance
40883 summary: create or update an existing vf-module
40885 Create or update an existing vf-module.
40887 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40888 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
40897 description: Response codes found in [response codes](https://wiki.onap.org/).
40901 description: Unique id of VNF. This is unique across the graph.
40904 example: __VNF-ID__
40905 - name: vf-module-id
40907 description: Unique ID of vf-module.
40910 example: __VF-MODULE-ID__
40913 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
40916 $ref: "#/definitions/vf-module"
40920 summary: update an existing vf-module
40922 Update an existing vf-module
40924 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40925 The PUT operation will entirely replace an existing object.
40926 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40928 Other differences between PUT and PATCH are:
40930 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40931 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40932 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40933 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
40942 description: Response codes found in [response codes](https://wiki.onap.org/).
40946 description: Unique id of VNF. This is unique across the graph.
40949 example: __VNF-ID__
40950 - name: vf-module-id
40952 description: Unique ID of vf-module.
40955 example: __VF-MODULE-ID__
40958 description: vf-module object that needs to be created or updated.
40961 $ref: "#/patchDefinitions/vf-module"
40965 summary: delete an existing vf-module
40966 description: delete an existing vf-module
40967 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
40976 description: Response codes found in [response codes](https://wiki.onap.org/).
40980 description: Unique id of VNF. This is unique across the graph.
40983 example: __VNF-ID__
40984 - name: vf-module-id
40986 description: Unique ID of vf-module.
40989 example: __VF-MODULE-ID__
40990 - name: resource-version
40992 description: resource-version for concurrency
40995 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
40999 summary: returns vf-modules
41000 description: returns vf-modules
41001 operationId: getNetworkGenericVnfsGenericVnfVfModules
41007 description: successful operation
41009 $ref: "#/getDefinitions/vf-modules"
41011 description: Response codes found in [response codes](https://wiki.onap.org/).
41015 description: Unique id of VNF. This is unique across the graph.
41018 example: __VNF-ID__
41021 description: Name of VNF.
41026 description: Alternate name of VNF.
41031 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.
41036 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
41039 - name: regional-resource-zone
41041 description: Regional way of organizing pservers, source of truth should define values
41044 - name: prov-status
41046 description: Trigger for operational monitoring of this resource by Service Assurance systems.
41049 - name: heat-stack-id
41051 description: Heat stack id corresponding to this instance, managed by MSO
41058 - name: is-closed-loop-disabled
41062 - name: model-invariant-id
41064 description: the ASDC model id for this resource or service model.
41067 - name: model-version-id
41069 description: the ASDC model version for this resource or service model.
41072 - name: widget-model-id
41074 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41077 - name: widget-model-version
41079 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41084 description: Generic description of the type of NF
41087 - name: nf-function
41089 description: English description of Network function that the specific VNF deployment is providing
41094 description: role in the network that this model will be providing
41097 - name: nf-naming-code
41099 description: string assigned to this model used for naming purposes
41102 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
41106 summary: see node definition for valid relationships
41107 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
41116 description: Response codes found in [response codes](https://wiki.onap.org/).
41120 description: Unique id of VNF. This is unique across the graph.
41123 example: __VNF-ID__
41126 description: Unique ID for the license group the resource belongs to, should be uuid.
41129 example: __GROUP-UUID__
41130 - name: resource-uuid
41132 description: Unique ID of a license resource.
41135 example: __RESOURCE-UUID__
41138 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)
41141 $ref: "#/definitions/relationship"
41145 summary: delete an existing relationship
41146 description: delete an existing relationship
41147 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
41156 description: Response codes found in [response codes](https://wiki.onap.org/).
41160 description: Unique id of VNF. This is unique across the graph.
41163 example: __VNF-ID__
41166 description: Unique ID for the license group the resource belongs to, should be uuid.
41169 example: __GROUP-UUID__
41170 - name: resource-uuid
41172 description: Unique ID of a license resource.
41175 example: __RESOURCE-UUID__
41176 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
41180 summary: returns license
41181 description: returns license
41182 operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
41188 description: successful operation
41190 $ref: "#/getDefinitions/license"
41192 description: Response codes found in [response codes](https://wiki.onap.org/).
41196 description: Unique id of VNF. This is unique across the graph.
41199 example: __VNF-ID__
41202 description: Unique ID for the license group the resource belongs to, should be uuid.
41205 example: __GROUP-UUID__
41206 - name: resource-uuid
41208 description: Unique ID of a license resource.
41211 example: __RESOURCE-UUID__
41214 description: Name of VNF.
41219 description: Alternate name of VNF.
41224 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.
41229 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
41232 - name: regional-resource-zone
41234 description: Regional way of organizing pservers, source of truth should define values
41237 - name: prov-status
41239 description: Trigger for operational monitoring of this resource by Service Assurance systems.
41242 - name: heat-stack-id
41244 description: Heat stack id corresponding to this instance, managed by MSO
41251 - name: is-closed-loop-disabled
41255 - name: model-invariant-id
41257 description: the ASDC model id for this resource or service model.
41260 - name: model-version-id
41262 description: the ASDC model version for this resource or service model.
41265 - name: widget-model-id
41267 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41270 - name: widget-model-version
41272 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41277 description: Generic description of the type of NF
41280 - name: nf-function
41282 description: English description of Network function that the specific VNF deployment is providing
41287 description: role in the network that this model will be providing
41290 - name: nf-naming-code
41292 description: string assigned to this model used for naming purposes
41298 summary: create or update an existing license
41300 Create or update an existing license.
41302 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41303 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
41312 description: Response codes found in [response codes](https://wiki.onap.org/).
41316 description: Unique id of VNF. This is unique across the graph.
41319 example: __VNF-ID__
41322 description: Unique ID for the license group the resource belongs to, should be uuid.
41325 example: __GROUP-UUID__
41326 - name: resource-uuid
41328 description: Unique ID of a license resource.
41331 example: __RESOURCE-UUID__
41334 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)
41337 $ref: "#/definitions/license"
41341 summary: update an existing license
41343 Update an existing license
41345 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41346 The PUT operation will entirely replace an existing object.
41347 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41349 Other differences between PUT and PATCH are:
41351 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41352 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41353 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41354 operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
41363 description: Response codes found in [response codes](https://wiki.onap.org/).
41367 description: Unique id of VNF. This is unique across the graph.
41370 example: __VNF-ID__
41373 description: Unique ID for the license group the resource belongs to, should be uuid.
41376 example: __GROUP-UUID__
41377 - name: resource-uuid
41379 description: Unique ID of a license resource.
41382 example: __RESOURCE-UUID__
41385 description: license object that needs to be created or updated.
41388 $ref: "#/patchDefinitions/license"
41392 summary: delete an existing license
41393 description: delete an existing license
41394 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
41403 description: Response codes found in [response codes](https://wiki.onap.org/).
41407 description: Unique id of VNF. This is unique across the graph.
41410 example: __VNF-ID__
41413 description: Unique ID for the license group the resource belongs to, should be uuid.
41416 example: __GROUP-UUID__
41417 - name: resource-uuid
41419 description: Unique ID of a license resource.
41422 example: __RESOURCE-UUID__
41423 - name: resource-version
41425 description: resource-version for concurrency
41428 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
41432 summary: returns licenses
41433 description: returns licenses
41434 operationId: getNetworkGenericVnfsGenericVnfLicenses
41440 description: successful operation
41442 $ref: "#/getDefinitions/licenses"
41444 description: Response codes found in [response codes](https://wiki.onap.org/).
41448 description: Unique id of VNF. This is unique across the graph.
41451 example: __VNF-ID__
41454 description: Name of VNF.
41459 description: Alternate name of VNF.
41464 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.
41469 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
41472 - name: regional-resource-zone
41474 description: Regional way of organizing pservers, source of truth should define values
41477 - name: prov-status
41479 description: Trigger for operational monitoring of this resource by Service Assurance systems.
41482 - name: heat-stack-id
41484 description: Heat stack id corresponding to this instance, managed by MSO
41491 - name: is-closed-loop-disabled
41495 - name: model-invariant-id
41497 description: the ASDC model id for this resource or service model.
41500 - name: model-version-id
41502 description: the ASDC model version for this resource or service model.
41505 - name: widget-model-id
41507 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41510 - name: widget-model-version
41512 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41517 description: Generic description of the type of NF
41520 - name: nf-function
41522 description: English description of Network function that the specific VNF deployment is providing
41527 description: role in the network that this model will be providing
41530 - name: nf-naming-code
41532 description: string assigned to this model used for naming purposes
41535 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
41539 summary: see node definition for valid relationships
41540 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
41549 description: Response codes found in [response codes](https://wiki.onap.org/).
41553 description: Unique id of VNF. This is unique across the graph.
41556 example: __VNF-ID__
41559 description: Unique ID for the entitlement group the resource comes from, should be uuid.
41562 example: __GROUP-UUID__
41563 - name: resource-uuid
41565 description: Unique ID of an entitlement resource.
41568 example: __RESOURCE-UUID__
41571 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
41574 $ref: "#/definitions/relationship"
41578 summary: delete an existing relationship
41579 description: delete an existing relationship
41580 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
41589 description: Response codes found in [response codes](https://wiki.onap.org/).
41593 description: Unique id of VNF. This is unique across the graph.
41596 example: __VNF-ID__
41599 description: Unique ID for the entitlement group the resource comes from, should be uuid.
41602 example: __GROUP-UUID__
41603 - name: resource-uuid
41605 description: Unique ID of an entitlement resource.
41608 example: __RESOURCE-UUID__
41609 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
41613 summary: returns entitlement
41614 description: returns entitlement
41615 operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41621 description: successful operation
41623 $ref: "#/getDefinitions/entitlement"
41625 description: Response codes found in [response codes](https://wiki.onap.org/).
41629 description: Unique id of VNF. This is unique across the graph.
41632 example: __VNF-ID__
41635 description: Unique ID for the entitlement group the resource comes from, should be uuid.
41638 example: __GROUP-UUID__
41639 - name: resource-uuid
41641 description: Unique ID of an entitlement resource.
41644 example: __RESOURCE-UUID__
41647 description: Name of VNF.
41652 description: Alternate name of VNF.
41657 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.
41662 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
41665 - name: regional-resource-zone
41667 description: Regional way of organizing pservers, source of truth should define values
41670 - name: prov-status
41672 description: Trigger for operational monitoring of this resource by Service Assurance systems.
41675 - name: heat-stack-id
41677 description: Heat stack id corresponding to this instance, managed by MSO
41684 - name: is-closed-loop-disabled
41688 - name: model-invariant-id
41690 description: the ASDC model id for this resource or service model.
41693 - name: model-version-id
41695 description: the ASDC model version for this resource or service model.
41698 - name: widget-model-id
41700 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41703 - name: widget-model-version
41705 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41710 description: Generic description of the type of NF
41713 - name: nf-function
41715 description: English description of Network function that the specific VNF deployment is providing
41720 description: role in the network that this model will be providing
41723 - name: nf-naming-code
41725 description: string assigned to this model used for naming purposes
41731 summary: create or update an existing entitlement
41733 Create or update an existing entitlement.
41735 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41736 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41745 description: Response codes found in [response codes](https://wiki.onap.org/).
41749 description: Unique id of VNF. This is unique across the graph.
41752 example: __VNF-ID__
41755 description: Unique ID for the entitlement group the resource comes from, should be uuid.
41758 example: __GROUP-UUID__
41759 - name: resource-uuid
41761 description: Unique ID of an entitlement resource.
41764 example: __RESOURCE-UUID__
41767 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
41770 $ref: "#/definitions/entitlement"
41774 summary: update an existing entitlement
41776 Update an existing entitlement
41778 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41779 The PUT operation will entirely replace an existing object.
41780 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41782 Other differences between PUT and PATCH are:
41784 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41785 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41786 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41787 operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41796 description: Response codes found in [response codes](https://wiki.onap.org/).
41800 description: Unique id of VNF. This is unique across the graph.
41803 example: __VNF-ID__
41806 description: Unique ID for the entitlement group the resource comes from, should be uuid.
41809 example: __GROUP-UUID__
41810 - name: resource-uuid
41812 description: Unique ID of an entitlement resource.
41815 example: __RESOURCE-UUID__
41818 description: entitlement object that needs to be created or updated.
41821 $ref: "#/patchDefinitions/entitlement"
41825 summary: delete an existing entitlement
41826 description: delete an existing entitlement
41827 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41836 description: Response codes found in [response codes](https://wiki.onap.org/).
41840 description: Unique id of VNF. This is unique across the graph.
41843 example: __VNF-ID__
41846 description: Unique ID for the entitlement group the resource comes from, should be uuid.
41849 example: __GROUP-UUID__
41850 - name: resource-uuid
41852 description: Unique ID of an entitlement resource.
41855 example: __RESOURCE-UUID__
41856 - name: resource-version
41858 description: resource-version for concurrency
41861 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
41865 summary: returns entitlements
41866 description: returns entitlements
41867 operationId: getNetworkGenericVnfsGenericVnfEntitlements
41873 description: successful operation
41875 $ref: "#/getDefinitions/entitlements"
41877 description: Response codes found in [response codes](https://wiki.onap.org/).
41881 description: Unique id of VNF. This is unique across the graph.
41884 example: __VNF-ID__
41887 description: Name of VNF.
41892 description: Alternate name of VNF.
41897 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.
41902 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
41905 - name: regional-resource-zone
41907 description: Regional way of organizing pservers, source of truth should define values
41910 - name: prov-status
41912 description: Trigger for operational monitoring of this resource by Service Assurance systems.
41915 - name: heat-stack-id
41917 description: Heat stack id corresponding to this instance, managed by MSO
41924 - name: is-closed-loop-disabled
41928 - name: model-invariant-id
41930 description: the ASDC model id for this resource or service model.
41933 - name: model-version-id
41935 description: the ASDC model version for this resource or service model.
41938 - name: widget-model-id
41940 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41943 - name: widget-model-version
41945 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41950 description: Generic description of the type of NF
41953 - name: nf-function
41955 description: English description of Network function that the specific VNF deployment is providing
41960 description: role in the network that this model will be providing
41963 - name: nf-naming-code
41965 description: string assigned to this model used for naming purposes
41968 /network/generic-vnfs/generic-vnf/{vnf-id}:
41972 summary: returns generic-vnf
41973 description: returns generic-vnf
41974 operationId: getNetworkGenericVnfsGenericVnf
41980 description: successful operation
41982 $ref: "#/getDefinitions/generic-vnf"
41984 description: Response codes found in [response codes](https://wiki.onap.org/).
41988 description: Unique id of VNF. This is unique across the graph.
41991 example: __VNF-ID__
41994 description: Name of VNF.
41999 description: Alternate name of VNF.
42004 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.
42009 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
42012 - name: regional-resource-zone
42014 description: Regional way of organizing pservers, source of truth should define values
42017 - name: prov-status
42019 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42022 - name: heat-stack-id
42024 description: Heat stack id corresponding to this instance, managed by MSO
42031 - name: is-closed-loop-disabled
42035 - name: model-invariant-id
42037 description: the ASDC model id for this resource or service model.
42040 - name: model-version-id
42042 description: the ASDC model version for this resource or service model.
42045 - name: widget-model-id
42047 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42050 - name: widget-model-version
42052 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42057 description: Generic description of the type of NF
42060 - name: nf-function
42062 description: English description of Network function that the specific VNF deployment is providing
42067 description: role in the network that this model will be providing
42070 - name: nf-naming-code
42072 description: string assigned to this model used for naming purposes
42078 summary: create or update an existing generic-vnf
42080 Create or update an existing generic-vnf.
42082 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42083 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
42092 description: Response codes found in [response codes](https://wiki.onap.org/).
42096 description: Unique id of VNF. This is unique across the graph.
42099 example: __VNF-ID__
42102 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)
42105 $ref: "#/definitions/generic-vnf"
42109 summary: update an existing generic-vnf
42111 Update an existing generic-vnf
42113 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42114 The PUT operation will entirely replace an existing object.
42115 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42117 Other differences between PUT and PATCH are:
42119 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42120 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42121 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42122 operationId: UpdateNetworkGenericVnfsGenericVnf
42131 description: Response codes found in [response codes](https://wiki.onap.org/).
42135 description: Unique id of VNF. This is unique across the graph.
42138 example: __VNF-ID__
42141 description: generic-vnf object that needs to be created or updated.
42144 $ref: "#/patchDefinitions/generic-vnf"
42148 summary: delete an existing generic-vnf
42149 description: delete an existing generic-vnf
42150 operationId: deleteNetworkGenericVnfsGenericVnf
42159 description: Response codes found in [response codes](https://wiki.onap.org/).
42163 description: Unique id of VNF. This is unique across the graph.
42166 example: __VNF-ID__
42167 - name: resource-version
42169 description: resource-version for concurrency
42172 /network/generic-vnfs:
42176 summary: returns generic-vnfs
42177 description: returns generic-vnfs
42178 operationId: getNetworkGenericVnfs
42184 description: successful operation
42186 $ref: "#/getDefinitions/generic-vnfs"
42188 description: Response codes found in [response codes](https://wiki.onap.org/).
42189 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
42193 summary: see node definition for valid relationships
42194 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
42203 description: Response codes found in [response codes](https://wiki.onap.org/).
42207 description: Alphabetical concatenation of lag-interface names
42210 example: __LINK-NAME__
42213 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)
42216 $ref: "#/definitions/relationship"
42220 summary: delete an existing relationship
42221 description: delete an existing relationship
42222 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
42231 description: Response codes found in [response codes](https://wiki.onap.org/).
42235 description: Alphabetical concatenation of lag-interface names
42238 example: __LINK-NAME__
42239 /network/lag-links/lag-link/{link-name}:
42243 summary: returns lag-link
42244 description: returns lag-link
42245 operationId: getNetworkLagLinksLagLink
42251 description: successful operation
42253 $ref: "#/getDefinitions/lag-link"
42255 description: Response codes found in [response codes](https://wiki.onap.org/).
42259 description: Alphabetical concatenation of lag-interface names
42262 example: __LINK-NAME__
42266 summary: create or update an existing lag-link
42268 Create or update an existing lag-link.
42270 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42271 operationId: createOrUpdateNetworkLagLinksLagLink
42280 description: Response codes found in [response codes](https://wiki.onap.org/).
42284 description: Alphabetical concatenation of lag-interface names
42287 example: __LINK-NAME__
42290 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)
42293 $ref: "#/definitions/lag-link"
42297 summary: update an existing lag-link
42299 Update an existing lag-link
42301 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42302 The PUT operation will entirely replace an existing object.
42303 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42305 Other differences between PUT and PATCH are:
42307 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42308 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42309 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42310 operationId: UpdateNetworkLagLinksLagLink
42319 description: Response codes found in [response codes](https://wiki.onap.org/).
42323 description: Alphabetical concatenation of lag-interface names
42326 example: __LINK-NAME__
42329 description: lag-link object that needs to be created or updated.
42332 $ref: "#/patchDefinitions/lag-link"
42336 summary: delete an existing lag-link
42337 description: delete an existing lag-link
42338 operationId: deleteNetworkLagLinksLagLink
42347 description: Response codes found in [response codes](https://wiki.onap.org/).
42351 description: Alphabetical concatenation of lag-interface names
42354 example: __LINK-NAME__
42355 - name: resource-version
42357 description: resource-version for concurrency
42360 /network/lag-links:
42364 summary: returns lag-links
42365 description: returns lag-links
42366 operationId: getNetworkLagLinks
42372 description: successful operation
42374 $ref: "#/getDefinitions/lag-links"
42376 description: Response codes found in [response codes](https://wiki.onap.org/).
42377 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
42381 summary: see node definition for valid relationships
42382 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
42391 description: Response codes found in [response codes](https://wiki.onap.org/).
42395 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42398 example: __VNF-ID2__
42401 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)
42404 $ref: "#/definitions/relationship"
42408 summary: delete an existing relationship
42409 description: delete an existing relationship
42410 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
42419 description: Response codes found in [response codes](https://wiki.onap.org/).
42423 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42426 example: __VNF-ID2__
42427 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
42431 summary: see node definition for valid relationships
42432 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42441 description: Response codes found in [response codes](https://wiki.onap.org/).
42445 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42448 example: __VNF-ID2__
42449 - name: interface-name
42451 description: Name given to the interface
42454 example: __INTERFACE-NAME__
42455 - name: vlan-interface
42457 description: String that identifies the interface
42460 example: __VLAN-INTERFACE__
42463 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
42466 $ref: "#/definitions/relationship"
42470 summary: delete an existing relationship
42471 description: delete an existing relationship
42472 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42481 description: Response codes found in [response codes](https://wiki.onap.org/).
42485 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42488 example: __VNF-ID2__
42489 - name: interface-name
42491 description: Name given to the interface
42494 example: __INTERFACE-NAME__
42495 - name: vlan-interface
42497 description: String that identifies the interface
42500 example: __VLAN-INTERFACE__
42501 /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:
42505 summary: see node definition for valid relationships
42506 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42515 description: Response codes found in [response codes](https://wiki.onap.org/).
42519 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42522 example: __VNF-ID2__
42523 - name: interface-name
42525 description: Name given to the interface
42528 example: __INTERFACE-NAME__
42529 - name: vlan-interface
42531 description: String that identifies the interface
42534 example: __VLAN-INTERFACE__
42535 - name: l3-interface-ipv4-address
42537 description: IP address
42540 example: __L3-INTERFACE-IPV4-ADDRESS__
42543 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42546 $ref: "#/definitions/relationship"
42550 summary: delete an existing relationship
42551 description: delete an existing relationship
42552 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42561 description: Response codes found in [response codes](https://wiki.onap.org/).
42565 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42568 example: __VNF-ID2__
42569 - name: interface-name
42571 description: Name given to the interface
42574 example: __INTERFACE-NAME__
42575 - name: vlan-interface
42577 description: String that identifies the interface
42580 example: __VLAN-INTERFACE__
42581 - name: l3-interface-ipv4-address
42583 description: IP address
42586 example: __L3-INTERFACE-IPV4-ADDRESS__
42587 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
42591 summary: returns l3-interface-ipv4-address-list
42592 description: returns l3-interface-ipv4-address-list
42593 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42599 description: successful operation
42601 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
42603 description: Response codes found in [response codes](https://wiki.onap.org/).
42607 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42610 example: __VNF-ID2__
42611 - name: interface-name
42613 description: Name given to the interface
42616 example: __INTERFACE-NAME__
42617 - name: vlan-interface
42619 description: String that identifies the interface
42622 example: __VLAN-INTERFACE__
42623 - name: l3-interface-ipv4-address
42625 description: IP address
42628 example: __L3-INTERFACE-IPV4-ADDRESS__
42631 description: Name of VNF.
42636 description: Alternate name of VNF.
42641 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.
42644 - name: prov-status
42646 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
42649 - name: heat-stack-id
42651 description: Heat stack id corresponding to this instance, managed by MSO
42654 - name: interface-id
42656 description: ID of interface
42661 description: MAC address for the interface
42664 - name: network-name
42666 description: Name of the network
42669 - name: vlan-id-inner
42671 description: Inner VLAN tag
42677 description: This indicates the customers VPN ID associated with this vlan
42680 - name: vlan-id-inner
42682 description: Inner VLAN tag
42686 - name: neutron-network-id
42688 description: Neutron network id of the interface that address belongs to
42691 - name: neutron-subnet-id
42693 description: Neutron id of subnet that address belongs to
42699 summary: create or update an existing l3-interface-ipv4-address-list
42701 Create or update an existing l3-interface-ipv4-address-list.
42703 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42704 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42713 description: Response codes found in [response codes](https://wiki.onap.org/).
42717 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42720 example: __VNF-ID2__
42721 - name: interface-name
42723 description: Name given to the interface
42726 example: __INTERFACE-NAME__
42727 - name: vlan-interface
42729 description: String that identifies the interface
42732 example: __VLAN-INTERFACE__
42733 - name: l3-interface-ipv4-address
42735 description: IP address
42738 example: __L3-INTERFACE-IPV4-ADDRESS__
42741 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42744 $ref: "#/definitions/l3-interface-ipv4-address-list"
42748 summary: update an existing l3-interface-ipv4-address-list
42750 Update an existing l3-interface-ipv4-address-list
42752 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42753 The PUT operation will entirely replace an existing object.
42754 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42756 Other differences between PUT and PATCH are:
42758 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42759 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42760 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42761 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42770 description: Response codes found in [response codes](https://wiki.onap.org/).
42774 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42777 example: __VNF-ID2__
42778 - name: interface-name
42780 description: Name given to the interface
42783 example: __INTERFACE-NAME__
42784 - name: vlan-interface
42786 description: String that identifies the interface
42789 example: __VLAN-INTERFACE__
42790 - name: l3-interface-ipv4-address
42792 description: IP address
42795 example: __L3-INTERFACE-IPV4-ADDRESS__
42798 description: l3-interface-ipv4-address-list object that needs to be created or updated.
42801 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42805 summary: delete an existing l3-interface-ipv4-address-list
42806 description: delete an existing l3-interface-ipv4-address-list
42807 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42816 description: Response codes found in [response codes](https://wiki.onap.org/).
42820 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42823 example: __VNF-ID2__
42824 - name: interface-name
42826 description: Name given to the interface
42829 example: __INTERFACE-NAME__
42830 - name: vlan-interface
42832 description: String that identifies the interface
42835 example: __VLAN-INTERFACE__
42836 - name: l3-interface-ipv4-address
42838 description: IP address
42841 example: __L3-INTERFACE-IPV4-ADDRESS__
42842 - name: resource-version
42844 description: resource-version for concurrency
42847 /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:
42851 summary: see node definition for valid relationships
42852 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42861 description: Response codes found in [response codes](https://wiki.onap.org/).
42865 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42868 example: __VNF-ID2__
42869 - name: interface-name
42871 description: Name given to the interface
42874 example: __INTERFACE-NAME__
42875 - name: vlan-interface
42877 description: String that identifies the interface
42880 example: __VLAN-INTERFACE__
42881 - name: l3-interface-ipv6-address
42883 description: IP address
42886 example: __L3-INTERFACE-IPV6-ADDRESS__
42889 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42892 $ref: "#/definitions/relationship"
42896 summary: delete an existing relationship
42897 description: delete an existing relationship
42898 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42907 description: Response codes found in [response codes](https://wiki.onap.org/).
42911 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42914 example: __VNF-ID2__
42915 - name: interface-name
42917 description: Name given to the interface
42920 example: __INTERFACE-NAME__
42921 - name: vlan-interface
42923 description: String that identifies the interface
42926 example: __VLAN-INTERFACE__
42927 - name: l3-interface-ipv6-address
42929 description: IP address
42932 example: __L3-INTERFACE-IPV6-ADDRESS__
42933 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
42937 summary: returns l3-interface-ipv6-address-list
42938 description: returns l3-interface-ipv6-address-list
42939 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42945 description: successful operation
42947 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42949 description: Response codes found in [response codes](https://wiki.onap.org/).
42953 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42956 example: __VNF-ID2__
42957 - name: interface-name
42959 description: Name given to the interface
42962 example: __INTERFACE-NAME__
42963 - name: vlan-interface
42965 description: String that identifies the interface
42968 example: __VLAN-INTERFACE__
42969 - name: l3-interface-ipv6-address
42971 description: IP address
42974 example: __L3-INTERFACE-IPV6-ADDRESS__
42977 description: Name of VNF.
42982 description: Alternate name of VNF.
42987 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.
42990 - name: prov-status
42992 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
42995 - name: heat-stack-id
42997 description: Heat stack id corresponding to this instance, managed by MSO
43000 - name: interface-id
43002 description: ID of interface
43007 description: MAC address for the interface
43010 - name: network-name
43012 description: Name of the network
43015 - name: vlan-id-inner
43017 description: Inner VLAN tag
43023 description: This indicates the customers VPN ID associated with this vlan
43026 - name: vlan-id-inner
43028 description: Inner VLAN tag
43032 - name: neutron-network-id
43034 description: Neutron network id of the interface that address belongs to
43037 - name: neutron-subnet-id
43039 description: Neutron id of subnet that address belongs to
43045 summary: create or update an existing l3-interface-ipv6-address-list
43047 Create or update an existing l3-interface-ipv6-address-list.
43049 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43050 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43059 description: Response codes found in [response codes](https://wiki.onap.org/).
43063 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43066 example: __VNF-ID2__
43067 - name: interface-name
43069 description: Name given to the interface
43072 example: __INTERFACE-NAME__
43073 - name: vlan-interface
43075 description: String that identifies the interface
43078 example: __VLAN-INTERFACE__
43079 - name: l3-interface-ipv6-address
43081 description: IP address
43084 example: __L3-INTERFACE-IPV6-ADDRESS__
43087 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
43090 $ref: "#/definitions/l3-interface-ipv6-address-list"
43094 summary: update an existing l3-interface-ipv6-address-list
43096 Update an existing l3-interface-ipv6-address-list
43098 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43099 The PUT operation will entirely replace an existing object.
43100 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43102 Other differences between PUT and PATCH are:
43104 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43105 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43106 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43107 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43116 description: Response codes found in [response codes](https://wiki.onap.org/).
43120 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43123 example: __VNF-ID2__
43124 - name: interface-name
43126 description: Name given to the interface
43129 example: __INTERFACE-NAME__
43130 - name: vlan-interface
43132 description: String that identifies the interface
43135 example: __VLAN-INTERFACE__
43136 - name: l3-interface-ipv6-address
43138 description: IP address
43141 example: __L3-INTERFACE-IPV6-ADDRESS__
43144 description: l3-interface-ipv6-address-list object that needs to be created or updated.
43147 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43151 summary: delete an existing l3-interface-ipv6-address-list
43152 description: delete an existing l3-interface-ipv6-address-list
43153 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43162 description: Response codes found in [response codes](https://wiki.onap.org/).
43166 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43169 example: __VNF-ID2__
43170 - name: interface-name
43172 description: Name given to the interface
43175 example: __INTERFACE-NAME__
43176 - name: vlan-interface
43178 description: String that identifies the interface
43181 example: __VLAN-INTERFACE__
43182 - name: l3-interface-ipv6-address
43184 description: IP address
43187 example: __L3-INTERFACE-IPV6-ADDRESS__
43188 - name: resource-version
43190 description: resource-version for concurrency
43193 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
43197 summary: returns vlan
43198 description: returns vlan
43199 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43205 description: successful operation
43207 $ref: "#/getDefinitions/vlan"
43209 description: Response codes found in [response codes](https://wiki.onap.org/).
43213 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43216 example: __VNF-ID2__
43217 - name: interface-name
43219 description: Name given to the interface
43222 example: __INTERFACE-NAME__
43223 - name: vlan-interface
43225 description: String that identifies the interface
43228 example: __VLAN-INTERFACE__
43231 description: Name of VNF.
43236 description: Alternate name of VNF.
43241 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.
43244 - name: prov-status
43246 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43249 - name: heat-stack-id
43251 description: Heat stack id corresponding to this instance, managed by MSO
43254 - name: interface-id
43256 description: ID of interface
43261 description: MAC address for the interface
43264 - name: network-name
43266 description: Name of the network
43269 - name: vlan-id-inner
43271 description: Inner VLAN tag
43277 description: This indicates the customers VPN ID associated with this vlan
43283 summary: create or update an existing vlan
43285 Create or update an existing vlan.
43287 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43288 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43297 description: Response codes found in [response codes](https://wiki.onap.org/).
43301 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43304 example: __VNF-ID2__
43305 - name: interface-name
43307 description: Name given to the interface
43310 example: __INTERFACE-NAME__
43311 - name: vlan-interface
43313 description: String that identifies the interface
43316 example: __VLAN-INTERFACE__
43319 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
43322 $ref: "#/definitions/vlan"
43326 summary: update an existing vlan
43328 Update an existing vlan
43330 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43331 The PUT operation will entirely replace an existing object.
43332 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43334 Other differences between PUT and PATCH are:
43336 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43337 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43338 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43339 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43348 description: Response codes found in [response codes](https://wiki.onap.org/).
43352 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43355 example: __VNF-ID2__
43356 - name: interface-name
43358 description: Name given to the interface
43361 example: __INTERFACE-NAME__
43362 - name: vlan-interface
43364 description: String that identifies the interface
43367 example: __VLAN-INTERFACE__
43370 description: vlan object that needs to be created or updated.
43373 $ref: "#/patchDefinitions/vlan"
43377 summary: delete an existing vlan
43378 description: delete an existing vlan
43379 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43388 description: Response codes found in [response codes](https://wiki.onap.org/).
43392 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43395 example: __VNF-ID2__
43396 - name: interface-name
43398 description: Name given to the interface
43401 example: __INTERFACE-NAME__
43402 - name: vlan-interface
43404 description: String that identifies the interface
43407 example: __VLAN-INTERFACE__
43408 - name: resource-version
43410 description: resource-version for concurrency
43413 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
43417 summary: returns vlans
43418 description: returns vlans
43419 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
43425 description: successful operation
43427 $ref: "#/getDefinitions/vlans"
43429 description: Response codes found in [response codes](https://wiki.onap.org/).
43433 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43436 example: __VNF-ID2__
43437 - name: interface-name
43439 description: Name given to the interface
43442 example: __INTERFACE-NAME__
43445 description: Name of VNF.
43450 description: Alternate name of VNF.
43455 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.
43458 - name: prov-status
43460 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43463 - name: heat-stack-id
43465 description: Heat stack id corresponding to this instance, managed by MSO
43468 - name: interface-id
43470 description: ID of interface
43475 description: MAC address for the interface
43478 - name: network-name
43480 description: Name of the network
43483 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
43487 summary: see node definition for valid relationships
43488 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
43497 description: Response codes found in [response codes](https://wiki.onap.org/).
43501 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43504 example: __VNF-ID2__
43505 - name: interface-name
43507 description: Name given to the interface
43510 example: __INTERFACE-NAME__
43513 description: PCI ID used to identify the sriov-vf
43516 example: __PCI-ID__
43519 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
43522 $ref: "#/definitions/relationship"
43526 summary: delete an existing relationship
43527 description: delete an existing relationship
43528 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
43537 description: Response codes found in [response codes](https://wiki.onap.org/).
43541 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43544 example: __VNF-ID2__
43545 - name: interface-name
43547 description: Name given to the interface
43550 example: __INTERFACE-NAME__
43553 description: PCI ID used to identify the sriov-vf
43556 example: __PCI-ID__
43557 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
43561 summary: returns sriov-vf
43562 description: returns sriov-vf
43563 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43569 description: successful operation
43571 $ref: "#/getDefinitions/sriov-vf"
43573 description: Response codes found in [response codes](https://wiki.onap.org/).
43577 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43580 example: __VNF-ID2__
43581 - name: interface-name
43583 description: Name given to the interface
43586 example: __INTERFACE-NAME__
43589 description: PCI ID used to identify the sriov-vf
43592 example: __PCI-ID__
43595 description: Name of VNF.
43600 description: Alternate name of VNF.
43605 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.
43608 - name: prov-status
43610 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43613 - name: heat-stack-id
43615 description: Heat stack id corresponding to this instance, managed by MSO
43618 - name: interface-id
43620 description: ID of interface
43625 description: MAC address for the interface
43628 - name: network-name
43630 description: Name of the network
43633 - name: vf-vlan-filter
43635 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
43638 - name: vf-mac-filter
43640 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
43643 - name: vf-vlan-strip
43645 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
43648 - name: neutron-network-id
43650 description: Neutron network id of the interface
43656 summary: create or update an existing sriov-vf
43658 Create or update an existing sriov-vf.
43660 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43661 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43670 description: Response codes found in [response codes](https://wiki.onap.org/).
43674 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43677 example: __VNF-ID2__
43678 - name: interface-name
43680 description: Name given to the interface
43683 example: __INTERFACE-NAME__
43686 description: PCI ID used to identify the sriov-vf
43689 example: __PCI-ID__
43692 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
43695 $ref: "#/definitions/sriov-vf"
43699 summary: update an existing sriov-vf
43701 Update an existing sriov-vf
43703 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43704 The PUT operation will entirely replace an existing object.
43705 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43707 Other differences between PUT and PATCH are:
43709 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43710 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43711 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43712 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43721 description: Response codes found in [response codes](https://wiki.onap.org/).
43725 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43728 example: __VNF-ID2__
43729 - name: interface-name
43731 description: Name given to the interface
43734 example: __INTERFACE-NAME__
43737 description: PCI ID used to identify the sriov-vf
43740 example: __PCI-ID__
43743 description: sriov-vf object that needs to be created or updated.
43746 $ref: "#/patchDefinitions/sriov-vf"
43750 summary: delete an existing sriov-vf
43751 description: delete an existing sriov-vf
43752 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43761 description: Response codes found in [response codes](https://wiki.onap.org/).
43765 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43768 example: __VNF-ID2__
43769 - name: interface-name
43771 description: Name given to the interface
43774 example: __INTERFACE-NAME__
43777 description: PCI ID used to identify the sriov-vf
43780 example: __PCI-ID__
43781 - name: resource-version
43783 description: resource-version for concurrency
43786 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
43790 summary: returns sriov-vfs
43791 description: returns sriov-vfs
43792 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
43798 description: successful operation
43800 $ref: "#/getDefinitions/sriov-vfs"
43802 description: Response codes found in [response codes](https://wiki.onap.org/).
43806 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43809 example: __VNF-ID2__
43810 - name: interface-name
43812 description: Name given to the interface
43815 example: __INTERFACE-NAME__
43818 description: Name of VNF.
43823 description: Alternate name of VNF.
43828 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.
43831 - name: prov-status
43833 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43836 - name: heat-stack-id
43838 description: Heat stack id corresponding to this instance, managed by MSO
43841 - name: interface-id
43843 description: ID of interface
43848 description: MAC address for the interface
43851 - name: network-name
43853 description: Name of the network
43856 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
43860 summary: see node definition for valid relationships
43861 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
43870 description: Response codes found in [response codes](https://wiki.onap.org/).
43874 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43877 example: __VNF-ID2__
43878 - name: interface-name
43880 description: Name given to the interface
43883 example: __INTERFACE-NAME__
43886 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)
43889 $ref: "#/definitions/relationship"
43893 summary: delete an existing relationship
43894 description: delete an existing relationship
43895 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
43904 description: Response codes found in [response codes](https://wiki.onap.org/).
43908 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43911 example: __VNF-ID2__
43912 - name: interface-name
43914 description: Name given to the interface
43917 example: __INTERFACE-NAME__
43918 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
43922 summary: see node definition for valid relationships
43923 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43932 description: Response codes found in [response codes](https://wiki.onap.org/).
43936 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43939 example: __VNF-ID2__
43940 - name: interface-name
43942 description: Name given to the interface
43945 example: __INTERFACE-NAME__
43946 - name: l3-interface-ipv4-address
43948 description: IP address
43951 example: __L3-INTERFACE-IPV4-ADDRESS__
43954 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43957 $ref: "#/definitions/relationship"
43961 summary: delete an existing relationship
43962 description: delete an existing relationship
43963 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43972 description: Response codes found in [response codes](https://wiki.onap.org/).
43976 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43979 example: __VNF-ID2__
43980 - name: interface-name
43982 description: Name given to the interface
43985 example: __INTERFACE-NAME__
43986 - name: l3-interface-ipv4-address
43988 description: IP address
43991 example: __L3-INTERFACE-IPV4-ADDRESS__
43992 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
43996 summary: returns l3-interface-ipv4-address-list
43997 description: returns l3-interface-ipv4-address-list
43998 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44004 description: successful operation
44006 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
44008 description: Response codes found in [response codes](https://wiki.onap.org/).
44012 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44015 example: __VNF-ID2__
44016 - name: interface-name
44018 description: Name given to the interface
44021 example: __INTERFACE-NAME__
44022 - name: l3-interface-ipv4-address
44024 description: IP address
44027 example: __L3-INTERFACE-IPV4-ADDRESS__
44030 description: Name of VNF.
44035 description: Alternate name of VNF.
44040 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.
44043 - name: prov-status
44045 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44048 - name: heat-stack-id
44050 description: Heat stack id corresponding to this instance, managed by MSO
44053 - name: interface-id
44055 description: ID of interface
44060 description: MAC address for the interface
44063 - name: network-name
44065 description: Name of the network
44068 - name: vlan-id-inner
44070 description: Inner VLAN tag
44074 - name: neutron-network-id
44076 description: Neutron network id of the interface that address belongs to
44079 - name: neutron-subnet-id
44081 description: Neutron id of subnet that address belongs to
44087 summary: create or update an existing l3-interface-ipv4-address-list
44089 Create or update an existing l3-interface-ipv4-address-list.
44091 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44092 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44101 description: Response codes found in [response codes](https://wiki.onap.org/).
44105 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44108 example: __VNF-ID2__
44109 - name: interface-name
44111 description: Name given to the interface
44114 example: __INTERFACE-NAME__
44115 - name: l3-interface-ipv4-address
44117 description: IP address
44120 example: __L3-INTERFACE-IPV4-ADDRESS__
44123 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
44126 $ref: "#/definitions/l3-interface-ipv4-address-list"
44130 summary: update an existing l3-interface-ipv4-address-list
44132 Update an existing l3-interface-ipv4-address-list
44134 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44135 The PUT operation will entirely replace an existing object.
44136 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44138 Other differences between PUT and PATCH are:
44140 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44141 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44142 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44143 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44152 description: Response codes found in [response codes](https://wiki.onap.org/).
44156 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44159 example: __VNF-ID2__
44160 - name: interface-name
44162 description: Name given to the interface
44165 example: __INTERFACE-NAME__
44166 - name: l3-interface-ipv4-address
44168 description: IP address
44171 example: __L3-INTERFACE-IPV4-ADDRESS__
44174 description: l3-interface-ipv4-address-list object that needs to be created or updated.
44177 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
44181 summary: delete an existing l3-interface-ipv4-address-list
44182 description: delete an existing l3-interface-ipv4-address-list
44183 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44192 description: Response codes found in [response codes](https://wiki.onap.org/).
44196 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44199 example: __VNF-ID2__
44200 - name: interface-name
44202 description: Name given to the interface
44205 example: __INTERFACE-NAME__
44206 - name: l3-interface-ipv4-address
44208 description: IP address
44211 example: __L3-INTERFACE-IPV4-ADDRESS__
44212 - name: resource-version
44214 description: resource-version for concurrency
44217 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
44221 summary: see node definition for valid relationships
44222 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
44231 description: Response codes found in [response codes](https://wiki.onap.org/).
44235 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44238 example: __VNF-ID2__
44239 - name: interface-name
44241 description: Name given to the interface
44244 example: __INTERFACE-NAME__
44245 - name: l3-interface-ipv6-address
44247 description: IP address
44250 example: __L3-INTERFACE-IPV6-ADDRESS__
44253 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
44256 $ref: "#/definitions/relationship"
44260 summary: delete an existing relationship
44261 description: delete an existing relationship
44262 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
44271 description: Response codes found in [response codes](https://wiki.onap.org/).
44275 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44278 example: __VNF-ID2__
44279 - name: interface-name
44281 description: Name given to the interface
44284 example: __INTERFACE-NAME__
44285 - name: l3-interface-ipv6-address
44287 description: IP address
44290 example: __L3-INTERFACE-IPV6-ADDRESS__
44291 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
44295 summary: returns l3-interface-ipv6-address-list
44296 description: returns l3-interface-ipv6-address-list
44297 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44303 description: successful operation
44305 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
44307 description: Response codes found in [response codes](https://wiki.onap.org/).
44311 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44314 example: __VNF-ID2__
44315 - name: interface-name
44317 description: Name given to the interface
44320 example: __INTERFACE-NAME__
44321 - name: l3-interface-ipv6-address
44323 description: IP address
44326 example: __L3-INTERFACE-IPV6-ADDRESS__
44329 description: Name of VNF.
44334 description: Alternate name of VNF.
44339 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.
44342 - name: prov-status
44344 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44347 - name: heat-stack-id
44349 description: Heat stack id corresponding to this instance, managed by MSO
44352 - name: interface-id
44354 description: ID of interface
44359 description: MAC address for the interface
44362 - name: network-name
44364 description: Name of the network
44367 - name: vlan-id-inner
44369 description: Inner VLAN tag
44373 - name: neutron-network-id
44375 description: Neutron network id of the interface that address belongs to
44378 - name: neutron-subnet-id
44380 description: Neutron id of subnet that address belongs to
44386 summary: create or update an existing l3-interface-ipv6-address-list
44388 Create or update an existing l3-interface-ipv6-address-list.
44390 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44391 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44400 description: Response codes found in [response codes](https://wiki.onap.org/).
44404 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44407 example: __VNF-ID2__
44408 - name: interface-name
44410 description: Name given to the interface
44413 example: __INTERFACE-NAME__
44414 - name: l3-interface-ipv6-address
44416 description: IP address
44419 example: __L3-INTERFACE-IPV6-ADDRESS__
44422 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
44425 $ref: "#/definitions/l3-interface-ipv6-address-list"
44429 summary: update an existing l3-interface-ipv6-address-list
44431 Update an existing l3-interface-ipv6-address-list
44433 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44434 The PUT operation will entirely replace an existing object.
44435 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44437 Other differences between PUT and PATCH are:
44439 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44440 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44441 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44442 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44451 description: Response codes found in [response codes](https://wiki.onap.org/).
44455 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44458 example: __VNF-ID2__
44459 - name: interface-name
44461 description: Name given to the interface
44464 example: __INTERFACE-NAME__
44465 - name: l3-interface-ipv6-address
44467 description: IP address
44470 example: __L3-INTERFACE-IPV6-ADDRESS__
44473 description: l3-interface-ipv6-address-list object that needs to be created or updated.
44476 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
44480 summary: delete an existing l3-interface-ipv6-address-list
44481 description: delete an existing l3-interface-ipv6-address-list
44482 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44491 description: Response codes found in [response codes](https://wiki.onap.org/).
44495 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44498 example: __VNF-ID2__
44499 - name: interface-name
44501 description: Name given to the interface
44504 example: __INTERFACE-NAME__
44505 - name: l3-interface-ipv6-address
44507 description: IP address
44510 example: __L3-INTERFACE-IPV6-ADDRESS__
44511 - name: resource-version
44513 description: resource-version for concurrency
44516 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
44520 summary: returns l-interface
44521 description: returns l-interface
44522 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
44528 description: successful operation
44530 $ref: "#/getDefinitions/l-interface"
44532 description: Response codes found in [response codes](https://wiki.onap.org/).
44536 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44539 example: __VNF-ID2__
44540 - name: interface-name
44542 description: Name given to the interface
44545 example: __INTERFACE-NAME__
44548 description: Name of VNF.
44553 description: Alternate name of VNF.
44558 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.
44561 - name: prov-status
44563 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44566 - name: heat-stack-id
44568 description: Heat stack id corresponding to this instance, managed by MSO
44571 - name: interface-id
44573 description: ID of interface
44578 description: MAC address for the interface
44581 - name: network-name
44583 description: Name of the network
44589 summary: create or update an existing l-interface
44591 Create or update an existing l-interface.
44593 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44594 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
44603 description: Response codes found in [response codes](https://wiki.onap.org/).
44607 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44610 example: __VNF-ID2__
44611 - name: interface-name
44613 description: Name given to the interface
44616 example: __INTERFACE-NAME__
44619 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)
44622 $ref: "#/definitions/l-interface"
44626 summary: update an existing l-interface
44628 Update an existing l-interface
44630 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44631 The PUT operation will entirely replace an existing object.
44632 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44634 Other differences between PUT and PATCH are:
44636 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44637 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44638 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44639 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
44648 description: Response codes found in [response codes](https://wiki.onap.org/).
44652 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44655 example: __VNF-ID2__
44656 - name: interface-name
44658 description: Name given to the interface
44661 example: __INTERFACE-NAME__
44664 description: l-interface object that needs to be created or updated.
44667 $ref: "#/patchDefinitions/l-interface"
44671 summary: delete an existing l-interface
44672 description: delete an existing l-interface
44673 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
44682 description: Response codes found in [response codes](https://wiki.onap.org/).
44686 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44689 example: __VNF-ID2__
44690 - name: interface-name
44692 description: Name given to the interface
44695 example: __INTERFACE-NAME__
44696 - name: resource-version
44698 description: resource-version for concurrency
44701 /network/newvces/newvce/{vnf-id2}/l-interfaces:
44705 summary: returns l-interfaces
44706 description: returns l-interfaces
44707 operationId: getNetworkNewvcesNewvceLInterfaces
44713 description: successful operation
44715 $ref: "#/getDefinitions/l-interfaces"
44717 description: Response codes found in [response codes](https://wiki.onap.org/).
44721 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44724 example: __VNF-ID2__
44727 description: Name of VNF.
44732 description: Alternate name of VNF.
44737 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.
44740 - name: prov-status
44742 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44745 - name: heat-stack-id
44747 description: Heat stack id corresponding to this instance, managed by MSO
44750 /network/newvces/newvce/{vnf-id2}:
44754 summary: returns newvce
44755 description: returns newvce
44756 operationId: getNetworkNewvcesNewvce
44762 description: successful operation
44764 $ref: "#/getDefinitions/newvce"
44766 description: Response codes found in [response codes](https://wiki.onap.org/).
44770 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44773 example: __VNF-ID2__
44776 description: Name of VNF.
44781 description: Alternate name of VNF.
44786 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.
44789 - name: prov-status
44791 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44794 - name: heat-stack-id
44796 description: Heat stack id corresponding to this instance, managed by MSO
44802 summary: create or update an existing newvce
44804 Create or update an existing newvce.
44806 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44807 operationId: createOrUpdateNetworkNewvcesNewvce
44816 description: Response codes found in [response codes](https://wiki.onap.org/).
44820 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44823 example: __VNF-ID2__
44826 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)
44829 $ref: "#/definitions/newvce"
44833 summary: update an existing newvce
44835 Update an existing newvce
44837 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44838 The PUT operation will entirely replace an existing object.
44839 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44841 Other differences between PUT and PATCH are:
44843 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44844 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44845 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44846 operationId: UpdateNetworkNewvcesNewvce
44855 description: Response codes found in [response codes](https://wiki.onap.org/).
44859 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44862 example: __VNF-ID2__
44865 description: newvce object that needs to be created or updated.
44868 $ref: "#/patchDefinitions/newvce"
44872 summary: delete an existing newvce
44873 description: delete an existing newvce
44874 operationId: deleteNetworkNewvcesNewvce
44883 description: Response codes found in [response codes](https://wiki.onap.org/).
44887 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44890 example: __VNF-ID2__
44891 - name: resource-version
44893 description: resource-version for concurrency
44900 summary: returns newvces
44901 description: returns newvces
44902 operationId: getNetworkNewvces
44908 description: successful operation
44910 $ref: "#/getDefinitions/newvces"
44912 description: Response codes found in [response codes](https://wiki.onap.org/).
44913 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
44917 summary: see node definition for valid relationships
44918 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
44927 description: Response codes found in [response codes](https://wiki.onap.org/).
44931 description: unique name of Physical Network Function.
44934 example: __PNF-NAME__
44937 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)
44940 $ref: "#/definitions/relationship"
44944 summary: delete an existing relationship
44945 description: delete an existing relationship
44946 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
44955 description: Response codes found in [response codes](https://wiki.onap.org/).
44959 description: unique name of Physical Network Function.
44962 example: __PNF-NAME__
44963 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
44967 summary: see node definition for valid relationships
44968 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
44977 description: Response codes found in [response codes](https://wiki.onap.org/).
44981 description: unique name of Physical Network Function.
44984 example: __PNF-NAME__
44985 - name: interface-name
44987 description: Name that identifies the physical interface
44990 example: __INTERFACE-NAME__
44993 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)
44996 $ref: "#/definitions/relationship"
45000 summary: delete an existing relationship
45001 description: delete an existing relationship
45002 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
45011 description: Response codes found in [response codes](https://wiki.onap.org/).
45015 description: unique name of Physical Network Function.
45018 example: __PNF-NAME__
45019 - name: interface-name
45021 description: Name that identifies the physical interface
45024 example: __INTERFACE-NAME__
45025 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
45029 summary: see node definition for valid relationships
45030 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
45039 description: Response codes found in [response codes](https://wiki.onap.org/).
45043 description: unique name of Physical Network Function.
45046 example: __PNF-NAME__
45047 - name: interface-name
45049 description: Name that identifies the physical interface
45052 example: __INTERFACE-NAME__
45055 description: Identifier for the sriov-pf
45058 example: __PF-PCI-ID__
45061 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
45064 $ref: "#/definitions/relationship"
45068 summary: delete an existing relationship
45069 description: delete an existing relationship
45070 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
45079 description: Response codes found in [response codes](https://wiki.onap.org/).
45083 description: unique name of Physical Network Function.
45086 example: __PNF-NAME__
45087 - name: interface-name
45089 description: Name that identifies the physical interface
45092 example: __INTERFACE-NAME__
45095 description: Identifier for the sriov-pf
45098 example: __PF-PCI-ID__
45099 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
45103 summary: returns sriov-pf
45104 description: returns sriov-pf
45105 operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45111 description: successful operation
45113 $ref: "#/getDefinitions/sriov-pf"
45115 description: Response codes found in [response codes](https://wiki.onap.org/).
45119 description: unique name of Physical Network Function.
45122 example: __PNF-NAME__
45123 - name: interface-name
45125 description: Name that identifies the physical interface
45128 example: __INTERFACE-NAME__
45131 description: Identifier for the sriov-pf
45134 example: __PF-PCI-ID__
45137 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45140 - name: prov-status
45142 description: Trigger for operational monitoring of this resource by Service Assurance systems.
45148 summary: create or update an existing sriov-pf
45150 Create or update an existing sriov-pf.
45152 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45153 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45162 description: Response codes found in [response codes](https://wiki.onap.org/).
45166 description: unique name of Physical Network Function.
45169 example: __PNF-NAME__
45170 - name: interface-name
45172 description: Name that identifies the physical interface
45175 example: __INTERFACE-NAME__
45178 description: Identifier for the sriov-pf
45181 example: __PF-PCI-ID__
45184 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
45187 $ref: "#/definitions/sriov-pf"
45191 summary: update an existing sriov-pf
45193 Update an existing sriov-pf
45195 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45196 The PUT operation will entirely replace an existing object.
45197 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45199 Other differences between PUT and PATCH are:
45201 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45202 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45203 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45204 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45213 description: Response codes found in [response codes](https://wiki.onap.org/).
45217 description: unique name of Physical Network Function.
45220 example: __PNF-NAME__
45221 - name: interface-name
45223 description: Name that identifies the physical interface
45226 example: __INTERFACE-NAME__
45229 description: Identifier for the sriov-pf
45232 example: __PF-PCI-ID__
45235 description: sriov-pf object that needs to be created or updated.
45238 $ref: "#/patchDefinitions/sriov-pf"
45242 summary: delete an existing sriov-pf
45243 description: delete an existing sriov-pf
45244 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45253 description: Response codes found in [response codes](https://wiki.onap.org/).
45257 description: unique name of Physical Network Function.
45260 example: __PNF-NAME__
45261 - name: interface-name
45263 description: Name that identifies the physical interface
45266 example: __INTERFACE-NAME__
45269 description: Identifier for the sriov-pf
45272 example: __PF-PCI-ID__
45273 - name: resource-version
45275 description: resource-version for concurrency
45278 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
45282 summary: returns sriov-pfs
45283 description: returns sriov-pfs
45284 operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
45290 description: successful operation
45292 $ref: "#/getDefinitions/sriov-pfs"
45294 description: Response codes found in [response codes](https://wiki.onap.org/).
45298 description: unique name of Physical Network Function.
45301 example: __PNF-NAME__
45302 - name: interface-name
45304 description: Name that identifies the physical interface
45307 example: __INTERFACE-NAME__
45310 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45313 - name: prov-status
45315 description: Trigger for operational monitoring of this resource by Service Assurance systems.
45318 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
45322 summary: see node definition for valid relationships
45323 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
45332 description: Response codes found in [response codes](https://wiki.onap.org/).
45336 description: unique name of Physical Network Function.
45339 example: __PNF-NAME__
45340 - name: interface-name
45342 description: Name that identifies the physical interface
45345 example: __INTERFACE-NAME__
45346 - name: interface-name
45348 description: Name given to the interface
45351 example: __INTERFACE-NAME__
45352 - name: vlan-interface
45354 description: String that identifies the interface
45357 example: __VLAN-INTERFACE__
45360 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
45363 $ref: "#/definitions/relationship"
45367 summary: delete an existing relationship
45368 description: delete an existing relationship
45369 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
45378 description: Response codes found in [response codes](https://wiki.onap.org/).
45382 description: unique name of Physical Network Function.
45385 example: __PNF-NAME__
45386 - name: interface-name
45388 description: Name that identifies the physical interface
45391 example: __INTERFACE-NAME__
45392 - name: interface-name
45394 description: Name given to the interface
45397 example: __INTERFACE-NAME__
45398 - name: vlan-interface
45400 description: String that identifies the interface
45403 example: __VLAN-INTERFACE__
45404 /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:
45408 summary: see node definition for valid relationships
45409 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
45418 description: Response codes found in [response codes](https://wiki.onap.org/).
45422 description: unique name of Physical Network Function.
45425 example: __PNF-NAME__
45426 - name: interface-name
45428 description: Name that identifies the physical interface
45431 example: __INTERFACE-NAME__
45432 - name: interface-name
45434 description: Name given to the interface
45437 example: __INTERFACE-NAME__
45438 - name: vlan-interface
45440 description: String that identifies the interface
45443 example: __VLAN-INTERFACE__
45444 - name: l3-interface-ipv4-address
45446 description: IP address
45449 example: __L3-INTERFACE-IPV4-ADDRESS__
45452 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
45455 $ref: "#/definitions/relationship"
45459 summary: delete an existing relationship
45460 description: delete an existing relationship
45461 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
45470 description: Response codes found in [response codes](https://wiki.onap.org/).
45474 description: unique name of Physical Network Function.
45477 example: __PNF-NAME__
45478 - name: interface-name
45480 description: Name that identifies the physical interface
45483 example: __INTERFACE-NAME__
45484 - name: interface-name
45486 description: Name given to the interface
45489 example: __INTERFACE-NAME__
45490 - name: vlan-interface
45492 description: String that identifies the interface
45495 example: __VLAN-INTERFACE__
45496 - name: l3-interface-ipv4-address
45498 description: IP address
45501 example: __L3-INTERFACE-IPV4-ADDRESS__
45502 /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}:
45506 summary: returns l3-interface-ipv4-address-list
45507 description: returns l3-interface-ipv4-address-list
45508 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45514 description: successful operation
45516 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
45518 description: Response codes found in [response codes](https://wiki.onap.org/).
45522 description: unique name of Physical Network Function.
45525 example: __PNF-NAME__
45526 - name: interface-name
45528 description: Name that identifies the physical interface
45531 example: __INTERFACE-NAME__
45532 - name: interface-name
45534 description: Name given to the interface
45537 example: __INTERFACE-NAME__
45538 - name: vlan-interface
45540 description: String that identifies the interface
45543 example: __VLAN-INTERFACE__
45544 - name: l3-interface-ipv4-address
45546 description: IP address
45549 example: __L3-INTERFACE-IPV4-ADDRESS__
45552 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45555 - name: prov-status
45557 description: Trigger for operational monitoring of this resource by Service Assurance systems.
45560 - name: interface-id
45562 description: ID of interface
45567 description: MAC address for the interface
45570 - name: network-name
45572 description: Name of the network
45575 - name: vlan-id-inner
45577 description: Inner VLAN tag
45583 description: This indicates the customers VPN ID associated with this vlan
45586 - name: vlan-id-inner
45588 description: Inner VLAN tag
45592 - name: neutron-network-id
45594 description: Neutron network id of the interface that address belongs to
45597 - name: neutron-subnet-id
45599 description: Neutron id of subnet that address belongs to
45605 summary: create or update an existing l3-interface-ipv4-address-list
45607 Create or update an existing l3-interface-ipv4-address-list.
45609 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45610 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45619 description: Response codes found in [response codes](https://wiki.onap.org/).
45623 description: unique name of Physical Network Function.
45626 example: __PNF-NAME__
45627 - name: interface-name
45629 description: Name that identifies the physical interface
45632 example: __INTERFACE-NAME__
45633 - name: interface-name
45635 description: Name given to the interface
45638 example: __INTERFACE-NAME__
45639 - name: vlan-interface
45641 description: String that identifies the interface
45644 example: __VLAN-INTERFACE__
45645 - name: l3-interface-ipv4-address
45647 description: IP address
45650 example: __L3-INTERFACE-IPV4-ADDRESS__
45653 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
45656 $ref: "#/definitions/l3-interface-ipv4-address-list"
45660 summary: update an existing l3-interface-ipv4-address-list
45662 Update an existing l3-interface-ipv4-address-list
45664 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45665 The PUT operation will entirely replace an existing object.
45666 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45668 Other differences between PUT and PATCH are:
45670 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45671 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45672 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45673 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45682 description: Response codes found in [response codes](https://wiki.onap.org/).
45686 description: unique name of Physical Network Function.
45689 example: __PNF-NAME__
45690 - name: interface-name
45692 description: Name that identifies the physical interface
45695 example: __INTERFACE-NAME__
45696 - name: interface-name
45698 description: Name given to the interface
45701 example: __INTERFACE-NAME__
45702 - name: vlan-interface
45704 description: String that identifies the interface
45707 example: __VLAN-INTERFACE__
45708 - name: l3-interface-ipv4-address
45710 description: IP address
45713 example: __L3-INTERFACE-IPV4-ADDRESS__
45716 description: l3-interface-ipv4-address-list object that needs to be created or updated.
45719 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
45723 summary: delete an existing l3-interface-ipv4-address-list
45724 description: delete an existing l3-interface-ipv4-address-list
45725 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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 physical interface
45747 example: __INTERFACE-NAME__
45748 - name: interface-name
45750 description: Name given to the interface
45753 example: __INTERFACE-NAME__
45754 - name: vlan-interface
45756 description: String that identifies the interface
45759 example: __VLAN-INTERFACE__
45760 - name: l3-interface-ipv4-address
45762 description: IP address
45765 example: __L3-INTERFACE-IPV4-ADDRESS__
45766 - name: resource-version
45768 description: resource-version for concurrency
45771 /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:
45775 summary: see node definition for valid relationships
45776 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
45785 description: Response codes found in [response codes](https://wiki.onap.org/).
45789 description: unique name of Physical Network Function.
45792 example: __PNF-NAME__
45793 - name: interface-name
45795 description: Name that identifies the physical interface
45798 example: __INTERFACE-NAME__
45799 - name: interface-name
45801 description: Name given to the interface
45804 example: __INTERFACE-NAME__
45805 - name: vlan-interface
45807 description: String that identifies the interface
45810 example: __VLAN-INTERFACE__
45811 - name: l3-interface-ipv6-address
45813 description: IP address
45816 example: __L3-INTERFACE-IPV6-ADDRESS__
45819 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
45822 $ref: "#/definitions/relationship"
45826 summary: delete an existing relationship
45827 description: delete an existing relationship
45828 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
45837 description: Response codes found in [response codes](https://wiki.onap.org/).
45841 description: unique name of Physical Network Function.
45844 example: __PNF-NAME__
45845 - name: interface-name
45847 description: Name that identifies the physical interface
45850 example: __INTERFACE-NAME__
45851 - name: interface-name
45853 description: Name given to the interface
45856 example: __INTERFACE-NAME__
45857 - name: vlan-interface
45859 description: String that identifies the interface
45862 example: __VLAN-INTERFACE__
45863 - name: l3-interface-ipv6-address
45865 description: IP address
45868 example: __L3-INTERFACE-IPV6-ADDRESS__
45869 /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}:
45873 summary: returns l3-interface-ipv6-address-list
45874 description: returns l3-interface-ipv6-address-list
45875 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45881 description: successful operation
45883 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
45885 description: Response codes found in [response codes](https://wiki.onap.org/).
45889 description: unique name of Physical Network Function.
45892 example: __PNF-NAME__
45893 - name: interface-name
45895 description: Name that identifies the physical interface
45898 example: __INTERFACE-NAME__
45899 - name: interface-name
45901 description: Name given to the interface
45904 example: __INTERFACE-NAME__
45905 - name: vlan-interface
45907 description: String that identifies the interface
45910 example: __VLAN-INTERFACE__
45911 - name: l3-interface-ipv6-address
45913 description: IP address
45916 example: __L3-INTERFACE-IPV6-ADDRESS__
45919 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45922 - name: prov-status
45924 description: Trigger for operational monitoring of this resource by Service Assurance systems.
45927 - name: interface-id
45929 description: ID of interface
45934 description: MAC address for the interface
45937 - name: network-name
45939 description: Name of the network
45942 - name: vlan-id-inner
45944 description: Inner VLAN tag
45950 description: This indicates the customers VPN ID associated with this vlan
45953 - name: vlan-id-inner
45955 description: Inner VLAN tag
45959 - name: neutron-network-id
45961 description: Neutron network id of the interface that address belongs to
45964 - name: neutron-subnet-id
45966 description: Neutron id of subnet that address belongs to
45972 summary: create or update an existing l3-interface-ipv6-address-list
45974 Create or update an existing l3-interface-ipv6-address-list.
45976 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45977 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45986 description: Response codes found in [response codes](https://wiki.onap.org/).
45990 description: unique name of Physical Network Function.
45993 example: __PNF-NAME__
45994 - name: interface-name
45996 description: Name that identifies the physical interface
45999 example: __INTERFACE-NAME__
46000 - name: interface-name
46002 description: Name given to the interface
46005 example: __INTERFACE-NAME__
46006 - name: vlan-interface
46008 description: String that identifies the interface
46011 example: __VLAN-INTERFACE__
46012 - name: l3-interface-ipv6-address
46014 description: IP address
46017 example: __L3-INTERFACE-IPV6-ADDRESS__
46020 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
46023 $ref: "#/definitions/l3-interface-ipv6-address-list"
46027 summary: update an existing l3-interface-ipv6-address-list
46029 Update an existing l3-interface-ipv6-address-list
46031 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46032 The PUT operation will entirely replace an existing object.
46033 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46035 Other differences between PUT and PATCH are:
46037 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46038 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46039 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46040 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
46049 description: Response codes found in [response codes](https://wiki.onap.org/).
46053 description: unique name of Physical Network Function.
46056 example: __PNF-NAME__
46057 - name: interface-name
46059 description: Name that identifies the physical interface
46062 example: __INTERFACE-NAME__
46063 - name: interface-name
46065 description: Name given to the interface
46068 example: __INTERFACE-NAME__
46069 - name: vlan-interface
46071 description: String that identifies the interface
46074 example: __VLAN-INTERFACE__
46075 - name: l3-interface-ipv6-address
46077 description: IP address
46080 example: __L3-INTERFACE-IPV6-ADDRESS__
46083 description: l3-interface-ipv6-address-list object that needs to be created or updated.
46086 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
46090 summary: delete an existing l3-interface-ipv6-address-list
46091 description: delete an existing l3-interface-ipv6-address-list
46092 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
46101 description: Response codes found in [response codes](https://wiki.onap.org/).
46105 description: unique name of Physical Network Function.
46108 example: __PNF-NAME__
46109 - name: interface-name
46111 description: Name that identifies the physical interface
46114 example: __INTERFACE-NAME__
46115 - name: interface-name
46117 description: Name given to the interface
46120 example: __INTERFACE-NAME__
46121 - name: vlan-interface
46123 description: String that identifies the interface
46126 example: __VLAN-INTERFACE__
46127 - name: l3-interface-ipv6-address
46129 description: IP address
46132 example: __L3-INTERFACE-IPV6-ADDRESS__
46133 - name: resource-version
46135 description: resource-version for concurrency
46138 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
46142 summary: returns vlan
46143 description: returns vlan
46144 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46150 description: successful operation
46152 $ref: "#/getDefinitions/vlan"
46154 description: Response codes found in [response codes](https://wiki.onap.org/).
46158 description: unique name of Physical Network Function.
46161 example: __PNF-NAME__
46162 - name: interface-name
46164 description: Name that identifies the physical interface
46167 example: __INTERFACE-NAME__
46168 - name: interface-name
46170 description: Name given to the interface
46173 example: __INTERFACE-NAME__
46174 - name: vlan-interface
46176 description: String that identifies the interface
46179 example: __VLAN-INTERFACE__
46182 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46185 - name: prov-status
46187 description: Trigger for operational monitoring of this resource by Service Assurance systems.
46190 - name: interface-id
46192 description: ID of interface
46197 description: MAC address for the interface
46200 - name: network-name
46202 description: Name of the network
46205 - name: vlan-id-inner
46207 description: Inner VLAN tag
46213 description: This indicates the customers VPN ID associated with this vlan
46219 summary: create or update an existing vlan
46221 Create or update an existing vlan.
46223 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46224 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46233 description: Response codes found in [response codes](https://wiki.onap.org/).
46237 description: unique name of Physical Network Function.
46240 example: __PNF-NAME__
46241 - name: interface-name
46243 description: Name that identifies the physical interface
46246 example: __INTERFACE-NAME__
46247 - name: interface-name
46249 description: Name given to the interface
46252 example: __INTERFACE-NAME__
46253 - name: vlan-interface
46255 description: String that identifies the interface
46258 example: __VLAN-INTERFACE__
46261 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
46264 $ref: "#/definitions/vlan"
46268 summary: update an existing vlan
46270 Update an existing vlan
46272 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46273 The PUT operation will entirely replace an existing object.
46274 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46276 Other differences between PUT and PATCH are:
46278 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46279 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46280 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46281 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46290 description: Response codes found in [response codes](https://wiki.onap.org/).
46294 description: unique name of Physical Network Function.
46297 example: __PNF-NAME__
46298 - name: interface-name
46300 description: Name that identifies the physical interface
46303 example: __INTERFACE-NAME__
46304 - name: interface-name
46306 description: Name given to the interface
46309 example: __INTERFACE-NAME__
46310 - name: vlan-interface
46312 description: String that identifies the interface
46315 example: __VLAN-INTERFACE__
46318 description: vlan object that needs to be created or updated.
46321 $ref: "#/patchDefinitions/vlan"
46325 summary: delete an existing vlan
46326 description: delete an existing vlan
46327 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46336 description: Response codes found in [response codes](https://wiki.onap.org/).
46340 description: unique name of Physical Network Function.
46343 example: __PNF-NAME__
46344 - name: interface-name
46346 description: Name that identifies the physical interface
46349 example: __INTERFACE-NAME__
46350 - name: interface-name
46352 description: Name given to the interface
46355 example: __INTERFACE-NAME__
46356 - name: vlan-interface
46358 description: String that identifies the interface
46361 example: __VLAN-INTERFACE__
46362 - name: resource-version
46364 description: resource-version for concurrency
46367 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
46371 summary: returns vlans
46372 description: returns vlans
46373 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
46379 description: successful operation
46381 $ref: "#/getDefinitions/vlans"
46383 description: Response codes found in [response codes](https://wiki.onap.org/).
46387 description: unique name of Physical Network Function.
46390 example: __PNF-NAME__
46391 - name: interface-name
46393 description: Name that identifies the physical interface
46396 example: __INTERFACE-NAME__
46397 - name: interface-name
46399 description: Name given to the interface
46402 example: __INTERFACE-NAME__
46405 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46408 - name: prov-status
46410 description: Trigger for operational monitoring of this resource by Service Assurance systems.
46413 - name: interface-id
46415 description: ID of interface
46420 description: MAC address for the interface
46423 - name: network-name
46425 description: Name of the network
46428 /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:
46432 summary: see node definition for valid relationships
46433 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
46442 description: Response codes found in [response codes](https://wiki.onap.org/).
46446 description: unique name of Physical Network Function.
46449 example: __PNF-NAME__
46450 - name: interface-name
46452 description: Name that identifies the physical interface
46455 example: __INTERFACE-NAME__
46456 - name: interface-name
46458 description: Name given to the interface
46461 example: __INTERFACE-NAME__
46464 description: PCI ID used to identify the sriov-vf
46467 example: __PCI-ID__
46470 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
46473 $ref: "#/definitions/relationship"
46477 summary: delete an existing relationship
46478 description: delete an existing relationship
46479 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
46488 description: Response codes found in [response codes](https://wiki.onap.org/).
46492 description: unique name of Physical Network Function.
46495 example: __PNF-NAME__
46496 - name: interface-name
46498 description: Name that identifies the physical interface
46501 example: __INTERFACE-NAME__
46502 - name: interface-name
46504 description: Name given to the interface
46507 example: __INTERFACE-NAME__
46510 description: PCI ID used to identify the sriov-vf
46513 example: __PCI-ID__
46514 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
46518 summary: returns sriov-vf
46519 description: returns sriov-vf
46520 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46526 description: successful operation
46528 $ref: "#/getDefinitions/sriov-vf"
46530 description: Response codes found in [response codes](https://wiki.onap.org/).
46534 description: unique name of Physical Network Function.
46537 example: __PNF-NAME__
46538 - name: interface-name
46540 description: Name that identifies the physical interface
46543 example: __INTERFACE-NAME__
46544 - name: interface-name
46546 description: Name given to the interface
46549 example: __INTERFACE-NAME__
46552 description: PCI ID used to identify the sriov-vf
46555 example: __PCI-ID__
46558 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46561 - name: prov-status
46563 description: Trigger for operational monitoring of this resource by Service Assurance systems.
46566 - name: interface-id
46568 description: ID of interface
46573 description: MAC address for the interface
46576 - name: network-name
46578 description: Name of the network
46581 - name: vf-vlan-filter
46583 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
46586 - name: vf-mac-filter
46588 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
46591 - name: vf-vlan-strip
46593 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
46596 - name: neutron-network-id
46598 description: Neutron network id of the interface
46604 summary: create or update an existing sriov-vf
46606 Create or update an existing sriov-vf.
46608 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46609 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46618 description: Response codes found in [response codes](https://wiki.onap.org/).
46622 description: unique name of Physical Network Function.
46625 example: __PNF-NAME__
46626 - name: interface-name
46628 description: Name that identifies the physical interface
46631 example: __INTERFACE-NAME__
46632 - name: interface-name
46634 description: Name given to the interface
46637 example: __INTERFACE-NAME__
46640 description: PCI ID used to identify the sriov-vf
46643 example: __PCI-ID__
46646 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
46649 $ref: "#/definitions/sriov-vf"
46653 summary: update an existing sriov-vf
46655 Update an existing sriov-vf
46657 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46658 The PUT operation will entirely replace an existing object.
46659 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46661 Other differences between PUT and PATCH are:
46663 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46664 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46665 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46666 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46675 description: Response codes found in [response codes](https://wiki.onap.org/).
46679 description: unique name of Physical Network Function.
46682 example: __PNF-NAME__
46683 - name: interface-name
46685 description: Name that identifies the physical interface
46688 example: __INTERFACE-NAME__
46689 - name: interface-name
46691 description: Name given to the interface
46694 example: __INTERFACE-NAME__
46697 description: PCI ID used to identify the sriov-vf
46700 example: __PCI-ID__
46703 description: sriov-vf object that needs to be created or updated.
46706 $ref: "#/patchDefinitions/sriov-vf"
46710 summary: delete an existing sriov-vf
46711 description: delete an existing sriov-vf
46712 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46721 description: Response codes found in [response codes](https://wiki.onap.org/).
46725 description: unique name of Physical Network Function.
46728 example: __PNF-NAME__
46729 - name: interface-name
46731 description: Name that identifies the physical interface
46734 example: __INTERFACE-NAME__
46735 - name: interface-name
46737 description: Name given to the interface
46740 example: __INTERFACE-NAME__
46743 description: PCI ID used to identify the sriov-vf
46746 example: __PCI-ID__
46747 - name: resource-version
46749 description: resource-version for concurrency
46752 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
46756 summary: returns sriov-vfs
46757 description: returns sriov-vfs
46758 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
46764 description: successful operation
46766 $ref: "#/getDefinitions/sriov-vfs"
46768 description: Response codes found in [response codes](https://wiki.onap.org/).
46772 description: unique name of Physical Network Function.
46775 example: __PNF-NAME__
46776 - name: interface-name
46778 description: Name that identifies the physical interface
46781 example: __INTERFACE-NAME__
46782 - name: interface-name
46784 description: Name given to the interface
46787 example: __INTERFACE-NAME__
46790 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46793 - name: prov-status
46795 description: Trigger for operational monitoring of this resource by Service Assurance systems.
46798 - name: interface-id
46800 description: ID of interface
46805 description: MAC address for the interface
46808 - name: network-name
46810 description: Name of the network
46813 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
46817 summary: see node definition for valid relationships
46818 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
46827 description: Response codes found in [response codes](https://wiki.onap.org/).
46831 description: unique name of Physical Network Function.
46834 example: __PNF-NAME__
46835 - name: interface-name
46837 description: Name that identifies the physical interface
46840 example: __INTERFACE-NAME__
46841 - name: interface-name
46843 description: Name given to the interface
46846 example: __INTERFACE-NAME__
46849 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
46852 $ref: "#/definitions/relationship"
46856 summary: delete an existing relationship
46857 description: delete an existing relationship
46858 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
46867 description: Response codes found in [response codes](https://wiki.onap.org/).
46871 description: unique name of Physical Network Function.
46874 example: __PNF-NAME__
46875 - name: interface-name
46877 description: Name that identifies the physical interface
46880 example: __INTERFACE-NAME__
46881 - name: interface-name
46883 description: Name given to the interface
46886 example: __INTERFACE-NAME__
46887 /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:
46891 summary: see node definition for valid relationships
46892 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46901 description: Response codes found in [response codes](https://wiki.onap.org/).
46905 description: unique name of Physical Network Function.
46908 example: __PNF-NAME__
46909 - name: interface-name
46911 description: Name that identifies the physical interface
46914 example: __INTERFACE-NAME__
46915 - name: interface-name
46917 description: Name given to the interface
46920 example: __INTERFACE-NAME__
46921 - name: l3-interface-ipv4-address
46923 description: IP address
46926 example: __L3-INTERFACE-IPV4-ADDRESS__
46929 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
46932 $ref: "#/definitions/relationship"
46936 summary: delete an existing relationship
46937 description: delete an existing relationship
46938 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46947 description: Response codes found in [response codes](https://wiki.onap.org/).
46951 description: unique name of Physical Network Function.
46954 example: __PNF-NAME__
46955 - name: interface-name
46957 description: Name that identifies the physical interface
46960 example: __INTERFACE-NAME__
46961 - name: interface-name
46963 description: Name given to the interface
46966 example: __INTERFACE-NAME__
46967 - name: l3-interface-ipv4-address
46969 description: IP address
46972 example: __L3-INTERFACE-IPV4-ADDRESS__
46973 /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}:
46977 summary: returns l3-interface-ipv4-address-list
46978 description: returns l3-interface-ipv4-address-list
46979 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46985 description: successful operation
46987 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
46989 description: Response codes found in [response codes](https://wiki.onap.org/).
46993 description: unique name of Physical Network Function.
46996 example: __PNF-NAME__
46997 - name: interface-name
46999 description: Name that identifies the physical interface
47002 example: __INTERFACE-NAME__
47003 - name: interface-name
47005 description: Name given to the interface
47008 example: __INTERFACE-NAME__
47009 - name: l3-interface-ipv4-address
47011 description: IP address
47014 example: __L3-INTERFACE-IPV4-ADDRESS__
47017 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
47020 - name: prov-status
47022 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47025 - name: interface-id
47027 description: ID of interface
47032 description: MAC address for the interface
47035 - name: network-name
47037 description: Name of the network
47040 - name: vlan-id-inner
47042 description: Inner VLAN tag
47046 - name: neutron-network-id
47048 description: Neutron network id of the interface that address belongs to
47051 - name: neutron-subnet-id
47053 description: Neutron id of subnet that address belongs to
47059 summary: create or update an existing l3-interface-ipv4-address-list
47061 Create or update an existing l3-interface-ipv4-address-list.
47063 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47064 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47073 description: Response codes found in [response codes](https://wiki.onap.org/).
47077 description: unique name of Physical Network Function.
47080 example: __PNF-NAME__
47081 - name: interface-name
47083 description: Name that identifies the physical interface
47086 example: __INTERFACE-NAME__
47087 - name: interface-name
47089 description: Name given to the interface
47092 example: __INTERFACE-NAME__
47093 - name: l3-interface-ipv4-address
47095 description: IP address
47098 example: __L3-INTERFACE-IPV4-ADDRESS__
47101 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
47104 $ref: "#/definitions/l3-interface-ipv4-address-list"
47108 summary: update an existing l3-interface-ipv4-address-list
47110 Update an existing l3-interface-ipv4-address-list
47112 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47113 The PUT operation will entirely replace an existing object.
47114 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47116 Other differences between PUT and PATCH are:
47118 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47119 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47120 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47121 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47130 description: Response codes found in [response codes](https://wiki.onap.org/).
47134 description: unique name of Physical Network Function.
47137 example: __PNF-NAME__
47138 - name: interface-name
47140 description: Name that identifies the physical interface
47143 example: __INTERFACE-NAME__
47144 - name: interface-name
47146 description: Name given to the interface
47149 example: __INTERFACE-NAME__
47150 - name: l3-interface-ipv4-address
47152 description: IP address
47155 example: __L3-INTERFACE-IPV4-ADDRESS__
47158 description: l3-interface-ipv4-address-list object that needs to be created or updated.
47161 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
47165 summary: delete an existing l3-interface-ipv4-address-list
47166 description: delete an existing l3-interface-ipv4-address-list
47167 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47176 description: Response codes found in [response codes](https://wiki.onap.org/).
47180 description: unique name of Physical Network Function.
47183 example: __PNF-NAME__
47184 - name: interface-name
47186 description: Name that identifies the physical interface
47189 example: __INTERFACE-NAME__
47190 - name: interface-name
47192 description: Name given to the interface
47195 example: __INTERFACE-NAME__
47196 - name: l3-interface-ipv4-address
47198 description: IP address
47201 example: __L3-INTERFACE-IPV4-ADDRESS__
47202 - name: resource-version
47204 description: resource-version for concurrency
47207 /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:
47211 summary: see node definition for valid relationships
47212 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
47221 description: Response codes found in [response codes](https://wiki.onap.org/).
47225 description: unique name of Physical Network Function.
47228 example: __PNF-NAME__
47229 - name: interface-name
47231 description: Name that identifies the physical interface
47234 example: __INTERFACE-NAME__
47235 - name: interface-name
47237 description: Name given to the interface
47240 example: __INTERFACE-NAME__
47241 - name: l3-interface-ipv6-address
47243 description: IP address
47246 example: __L3-INTERFACE-IPV6-ADDRESS__
47249 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
47252 $ref: "#/definitions/relationship"
47256 summary: delete an existing relationship
47257 description: delete an existing relationship
47258 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
47267 description: Response codes found in [response codes](https://wiki.onap.org/).
47271 description: unique name of Physical Network Function.
47274 example: __PNF-NAME__
47275 - name: interface-name
47277 description: Name that identifies the physical interface
47280 example: __INTERFACE-NAME__
47281 - name: interface-name
47283 description: Name given to the interface
47286 example: __INTERFACE-NAME__
47287 - name: l3-interface-ipv6-address
47289 description: IP address
47292 example: __L3-INTERFACE-IPV6-ADDRESS__
47293 /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}:
47297 summary: returns l3-interface-ipv6-address-list
47298 description: returns l3-interface-ipv6-address-list
47299 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47305 description: successful operation
47307 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
47309 description: Response codes found in [response codes](https://wiki.onap.org/).
47313 description: unique name of Physical Network Function.
47316 example: __PNF-NAME__
47317 - name: interface-name
47319 description: Name that identifies the physical interface
47322 example: __INTERFACE-NAME__
47323 - name: interface-name
47325 description: Name given to the interface
47328 example: __INTERFACE-NAME__
47329 - name: l3-interface-ipv6-address
47331 description: IP address
47334 example: __L3-INTERFACE-IPV6-ADDRESS__
47337 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
47340 - name: prov-status
47342 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47345 - name: interface-id
47347 description: ID of interface
47352 description: MAC address for the interface
47355 - name: network-name
47357 description: Name of the network
47360 - name: vlan-id-inner
47362 description: Inner VLAN tag
47366 - name: neutron-network-id
47368 description: Neutron network id of the interface that address belongs to
47371 - name: neutron-subnet-id
47373 description: Neutron id of subnet that address belongs to
47379 summary: create or update an existing l3-interface-ipv6-address-list
47381 Create or update an existing l3-interface-ipv6-address-list.
47383 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47384 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47393 description: Response codes found in [response codes](https://wiki.onap.org/).
47397 description: unique name of Physical Network Function.
47400 example: __PNF-NAME__
47401 - name: interface-name
47403 description: Name that identifies the physical interface
47406 example: __INTERFACE-NAME__
47407 - name: interface-name
47409 description: Name given to the interface
47412 example: __INTERFACE-NAME__
47413 - name: l3-interface-ipv6-address
47415 description: IP address
47418 example: __L3-INTERFACE-IPV6-ADDRESS__
47421 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
47424 $ref: "#/definitions/l3-interface-ipv6-address-list"
47428 summary: update an existing l3-interface-ipv6-address-list
47430 Update an existing l3-interface-ipv6-address-list
47432 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47433 The PUT operation will entirely replace an existing object.
47434 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47436 Other differences between PUT and PATCH are:
47438 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47439 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47440 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47441 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47450 description: Response codes found in [response codes](https://wiki.onap.org/).
47454 description: unique name of Physical Network Function.
47457 example: __PNF-NAME__
47458 - name: interface-name
47460 description: Name that identifies the physical interface
47463 example: __INTERFACE-NAME__
47464 - name: interface-name
47466 description: Name given to the interface
47469 example: __INTERFACE-NAME__
47470 - name: l3-interface-ipv6-address
47472 description: IP address
47475 example: __L3-INTERFACE-IPV6-ADDRESS__
47478 description: l3-interface-ipv6-address-list object that needs to be created or updated.
47481 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
47485 summary: delete an existing l3-interface-ipv6-address-list
47486 description: delete an existing l3-interface-ipv6-address-list
47487 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47496 description: Response codes found in [response codes](https://wiki.onap.org/).
47500 description: unique name of Physical Network Function.
47503 example: __PNF-NAME__
47504 - name: interface-name
47506 description: Name that identifies the physical interface
47509 example: __INTERFACE-NAME__
47510 - name: interface-name
47512 description: Name given to the interface
47515 example: __INTERFACE-NAME__
47516 - name: l3-interface-ipv6-address
47518 description: IP address
47521 example: __L3-INTERFACE-IPV6-ADDRESS__
47522 - name: resource-version
47524 description: resource-version for concurrency
47527 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
47531 summary: returns l-interface
47532 description: returns l-interface
47533 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47539 description: successful operation
47541 $ref: "#/getDefinitions/l-interface"
47543 description: Response codes found in [response codes](https://wiki.onap.org/).
47547 description: unique name of Physical Network Function.
47550 example: __PNF-NAME__
47551 - name: interface-name
47553 description: Name that identifies the physical interface
47556 example: __INTERFACE-NAME__
47557 - name: interface-name
47559 description: Name given to the interface
47562 example: __INTERFACE-NAME__
47565 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
47568 - name: prov-status
47570 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47573 - name: interface-id
47575 description: ID of interface
47580 description: MAC address for the interface
47583 - name: network-name
47585 description: Name of the network
47591 summary: create or update an existing l-interface
47593 Create or update an existing l-interface.
47595 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47596 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47605 description: Response codes found in [response codes](https://wiki.onap.org/).
47609 description: unique name of Physical Network Function.
47612 example: __PNF-NAME__
47613 - name: interface-name
47615 description: Name that identifies the physical interface
47618 example: __INTERFACE-NAME__
47619 - name: interface-name
47621 description: Name given to the interface
47624 example: __INTERFACE-NAME__
47627 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
47630 $ref: "#/definitions/l-interface"
47634 summary: update an existing l-interface
47636 Update an existing l-interface
47638 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47639 The PUT operation will entirely replace an existing object.
47640 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47642 Other differences between PUT and PATCH are:
47644 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47645 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47646 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47647 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47656 description: Response codes found in [response codes](https://wiki.onap.org/).
47660 description: unique name of Physical Network Function.
47663 example: __PNF-NAME__
47664 - name: interface-name
47666 description: Name that identifies the physical interface
47669 example: __INTERFACE-NAME__
47670 - name: interface-name
47672 description: Name given to the interface
47675 example: __INTERFACE-NAME__
47678 description: l-interface object that needs to be created or updated.
47681 $ref: "#/patchDefinitions/l-interface"
47685 summary: delete an existing l-interface
47686 description: delete an existing l-interface
47687 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47696 description: Response codes found in [response codes](https://wiki.onap.org/).
47700 description: unique name of Physical Network Function.
47703 example: __PNF-NAME__
47704 - name: interface-name
47706 description: Name that identifies the physical interface
47709 example: __INTERFACE-NAME__
47710 - name: interface-name
47712 description: Name given to the interface
47715 example: __INTERFACE-NAME__
47716 - name: resource-version
47718 description: resource-version for concurrency
47721 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
47725 summary: returns l-interfaces
47726 description: returns l-interfaces
47727 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
47733 description: successful operation
47735 $ref: "#/getDefinitions/l-interfaces"
47737 description: Response codes found in [response codes](https://wiki.onap.org/).
47741 description: unique name of Physical Network Function.
47744 example: __PNF-NAME__
47745 - name: interface-name
47747 description: Name that identifies the physical interface
47750 example: __INTERFACE-NAME__
47753 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
47756 - name: prov-status
47758 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47761 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
47765 summary: returns p-interface
47766 description: returns p-interface
47767 operationId: getNetworkPnfsPnfPInterfacesPInterface
47773 description: successful operation
47775 $ref: "#/getDefinitions/p-interface"
47777 description: Response codes found in [response codes](https://wiki.onap.org/).
47781 description: unique name of Physical Network Function.
47784 example: __PNF-NAME__
47785 - name: interface-name
47787 description: Name that identifies the physical interface
47790 example: __INTERFACE-NAME__
47793 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
47796 - name: prov-status
47798 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47804 summary: create or update an existing p-interface
47806 Create or update an existing p-interface.
47808 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47809 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
47818 description: Response codes found in [response codes](https://wiki.onap.org/).
47822 description: unique name of Physical Network Function.
47825 example: __PNF-NAME__
47826 - name: interface-name
47828 description: Name that identifies the physical interface
47831 example: __INTERFACE-NAME__
47834 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)
47837 $ref: "#/definitions/p-interface"
47841 summary: update an existing p-interface
47843 Update an existing p-interface
47845 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47846 The PUT operation will entirely replace an existing object.
47847 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47849 Other differences between PUT and PATCH are:
47851 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47852 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47853 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47854 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
47863 description: Response codes found in [response codes](https://wiki.onap.org/).
47867 description: unique name of Physical Network Function.
47870 example: __PNF-NAME__
47871 - name: interface-name
47873 description: Name that identifies the physical interface
47876 example: __INTERFACE-NAME__
47879 description: p-interface object that needs to be created or updated.
47882 $ref: "#/patchDefinitions/p-interface"
47886 summary: delete an existing p-interface
47887 description: delete an existing p-interface
47888 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
47897 description: Response codes found in [response codes](https://wiki.onap.org/).
47901 description: unique name of Physical Network Function.
47904 example: __PNF-NAME__
47905 - name: interface-name
47907 description: Name that identifies the physical interface
47910 example: __INTERFACE-NAME__
47911 - name: resource-version
47913 description: resource-version for concurrency
47916 /network/pnfs/pnf/{pnf-name}/p-interfaces:
47920 summary: returns p-interfaces
47921 description: returns p-interfaces
47922 operationId: getNetworkPnfsPnfPInterfaces
47928 description: successful operation
47930 $ref: "#/getDefinitions/p-interfaces"
47932 description: Response codes found in [response codes](https://wiki.onap.org/).
47936 description: unique name of Physical Network Function.
47939 example: __PNF-NAME__
47942 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
47945 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
47949 summary: see node definition for valid relationships
47950 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
47959 description: Response codes found in [response codes](https://wiki.onap.org/).
47963 description: unique name of Physical Network Function.
47966 example: __PNF-NAME__
47967 - name: interface-name
47969 description: Name that identifies the link aggregate interface
47972 example: __INTERFACE-NAME__
47975 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)
47978 $ref: "#/definitions/relationship"
47982 summary: delete an existing relationship
47983 description: delete an existing relationship
47984 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
47993 description: Response codes found in [response codes](https://wiki.onap.org/).
47997 description: unique name of Physical Network Function.
48000 example: __PNF-NAME__
48001 - name: interface-name
48003 description: Name that identifies the link aggregate interface
48006 example: __INTERFACE-NAME__
48007 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
48011 summary: see node definition for valid relationships
48012 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
48021 description: Response codes found in [response codes](https://wiki.onap.org/).
48025 description: unique name of Physical Network Function.
48028 example: __PNF-NAME__
48029 - name: interface-name
48031 description: Name that identifies the link aggregate interface
48034 example: __INTERFACE-NAME__
48035 - name: interface-name
48037 description: Name given to the interface
48040 example: __INTERFACE-NAME__
48041 - name: vlan-interface
48043 description: String that identifies the interface
48046 example: __VLAN-INTERFACE__
48049 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
48052 $ref: "#/definitions/relationship"
48056 summary: delete an existing relationship
48057 description: delete an existing relationship
48058 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
48067 description: Response codes found in [response codes](https://wiki.onap.org/).
48071 description: unique name of Physical Network Function.
48074 example: __PNF-NAME__
48075 - name: interface-name
48077 description: Name that identifies the link aggregate interface
48080 example: __INTERFACE-NAME__
48081 - name: interface-name
48083 description: Name given to the interface
48086 example: __INTERFACE-NAME__
48087 - name: vlan-interface
48089 description: String that identifies the interface
48092 example: __VLAN-INTERFACE__
48093 /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:
48097 summary: see node definition for valid relationships
48098 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
48107 description: Response codes found in [response codes](https://wiki.onap.org/).
48111 description: unique name of Physical Network Function.
48114 example: __PNF-NAME__
48115 - name: interface-name
48117 description: Name that identifies the link aggregate interface
48120 example: __INTERFACE-NAME__
48121 - name: interface-name
48123 description: Name given to the interface
48126 example: __INTERFACE-NAME__
48127 - name: vlan-interface
48129 description: String that identifies the interface
48132 example: __VLAN-INTERFACE__
48133 - name: l3-interface-ipv4-address
48135 description: IP address
48138 example: __L3-INTERFACE-IPV4-ADDRESS__
48141 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
48144 $ref: "#/definitions/relationship"
48148 summary: delete an existing relationship
48149 description: delete an existing relationship
48150 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
48159 description: Response codes found in [response codes](https://wiki.onap.org/).
48163 description: unique name of Physical Network Function.
48166 example: __PNF-NAME__
48167 - name: interface-name
48169 description: Name that identifies the link aggregate interface
48172 example: __INTERFACE-NAME__
48173 - name: interface-name
48175 description: Name given to the interface
48178 example: __INTERFACE-NAME__
48179 - name: vlan-interface
48181 description: String that identifies the interface
48184 example: __VLAN-INTERFACE__
48185 - name: l3-interface-ipv4-address
48187 description: IP address
48190 example: __L3-INTERFACE-IPV4-ADDRESS__
48191 /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}:
48195 summary: returns l3-interface-ipv4-address-list
48196 description: returns l3-interface-ipv4-address-list
48197 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48203 description: successful operation
48205 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
48207 description: Response codes found in [response codes](https://wiki.onap.org/).
48211 description: unique name of Physical Network Function.
48214 example: __PNF-NAME__
48215 - name: interface-name
48217 description: Name that identifies the link aggregate interface
48220 example: __INTERFACE-NAME__
48221 - name: interface-name
48223 description: Name given to the interface
48226 example: __INTERFACE-NAME__
48227 - name: vlan-interface
48229 description: String that identifies the interface
48232 example: __VLAN-INTERFACE__
48233 - name: l3-interface-ipv4-address
48235 description: IP address
48238 example: __L3-INTERFACE-IPV4-ADDRESS__
48241 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
48244 - name: interface-id
48246 description: ID of interface
48249 - name: interface-role
48251 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48254 - name: interface-id
48256 description: ID of interface
48261 description: MAC address for the interface
48264 - name: network-name
48266 description: Name of the network
48269 - name: vlan-id-inner
48271 description: Inner VLAN tag
48277 description: This indicates the customers VPN ID associated with this vlan
48280 - name: vlan-id-inner
48282 description: Inner VLAN tag
48286 - name: neutron-network-id
48288 description: Neutron network id of the interface that address belongs to
48291 - name: neutron-subnet-id
48293 description: Neutron id of subnet that address belongs to
48299 summary: create or update an existing l3-interface-ipv4-address-list
48301 Create or update an existing l3-interface-ipv4-address-list.
48303 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
48304 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48313 description: Response codes found in [response codes](https://wiki.onap.org/).
48317 description: unique name of Physical Network Function.
48320 example: __PNF-NAME__
48321 - name: interface-name
48323 description: Name that identifies the link aggregate interface
48326 example: __INTERFACE-NAME__
48327 - name: interface-name
48329 description: Name given to the interface
48332 example: __INTERFACE-NAME__
48333 - name: vlan-interface
48335 description: String that identifies the interface
48338 example: __VLAN-INTERFACE__
48339 - name: l3-interface-ipv4-address
48341 description: IP address
48344 example: __L3-INTERFACE-IPV4-ADDRESS__
48347 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
48350 $ref: "#/definitions/l3-interface-ipv4-address-list"
48354 summary: update an existing l3-interface-ipv4-address-list
48356 Update an existing l3-interface-ipv4-address-list
48358 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48359 The PUT operation will entirely replace an existing object.
48360 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
48362 Other differences between PUT and PATCH are:
48364 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
48365 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48366 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48367 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48376 description: Response codes found in [response codes](https://wiki.onap.org/).
48380 description: unique name of Physical Network Function.
48383 example: __PNF-NAME__
48384 - name: interface-name
48386 description: Name that identifies the link aggregate interface
48389 example: __INTERFACE-NAME__
48390 - name: interface-name
48392 description: Name given to the interface
48395 example: __INTERFACE-NAME__
48396 - name: vlan-interface
48398 description: String that identifies the interface
48401 example: __VLAN-INTERFACE__
48402 - name: l3-interface-ipv4-address
48404 description: IP address
48407 example: __L3-INTERFACE-IPV4-ADDRESS__
48410 description: l3-interface-ipv4-address-list object that needs to be created or updated.
48413 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
48417 summary: delete an existing l3-interface-ipv4-address-list
48418 description: delete an existing l3-interface-ipv4-address-list
48419 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48428 description: Response codes found in [response codes](https://wiki.onap.org/).
48432 description: unique name of Physical Network Function.
48435 example: __PNF-NAME__
48436 - name: interface-name
48438 description: Name that identifies the link aggregate interface
48441 example: __INTERFACE-NAME__
48442 - name: interface-name
48444 description: Name given to the interface
48447 example: __INTERFACE-NAME__
48448 - name: vlan-interface
48450 description: String that identifies the interface
48453 example: __VLAN-INTERFACE__
48454 - name: l3-interface-ipv4-address
48456 description: IP address
48459 example: __L3-INTERFACE-IPV4-ADDRESS__
48460 - name: resource-version
48462 description: resource-version for concurrency
48465 /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:
48469 summary: see node definition for valid relationships
48470 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
48479 description: Response codes found in [response codes](https://wiki.onap.org/).
48483 description: unique name of Physical Network Function.
48486 example: __PNF-NAME__
48487 - name: interface-name
48489 description: Name that identifies the link aggregate interface
48492 example: __INTERFACE-NAME__
48493 - name: interface-name
48495 description: Name given to the interface
48498 example: __INTERFACE-NAME__
48499 - name: vlan-interface
48501 description: String that identifies the interface
48504 example: __VLAN-INTERFACE__
48505 - name: l3-interface-ipv6-address
48507 description: IP address
48510 example: __L3-INTERFACE-IPV6-ADDRESS__
48513 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
48516 $ref: "#/definitions/relationship"
48520 summary: delete an existing relationship
48521 description: delete an existing relationship
48522 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
48531 description: Response codes found in [response codes](https://wiki.onap.org/).
48535 description: unique name of Physical Network Function.
48538 example: __PNF-NAME__
48539 - name: interface-name
48541 description: Name that identifies the link aggregate interface
48544 example: __INTERFACE-NAME__
48545 - name: interface-name
48547 description: Name given to the interface
48550 example: __INTERFACE-NAME__
48551 - name: vlan-interface
48553 description: String that identifies the interface
48556 example: __VLAN-INTERFACE__
48557 - name: l3-interface-ipv6-address
48559 description: IP address
48562 example: __L3-INTERFACE-IPV6-ADDRESS__
48563 /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}:
48567 summary: returns l3-interface-ipv6-address-list
48568 description: returns l3-interface-ipv6-address-list
48569 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48575 description: successful operation
48577 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
48579 description: Response codes found in [response codes](https://wiki.onap.org/).
48583 description: unique name of Physical Network Function.
48586 example: __PNF-NAME__
48587 - name: interface-name
48589 description: Name that identifies the link aggregate interface
48592 example: __INTERFACE-NAME__
48593 - name: interface-name
48595 description: Name given to the interface
48598 example: __INTERFACE-NAME__
48599 - name: vlan-interface
48601 description: String that identifies the interface
48604 example: __VLAN-INTERFACE__
48605 - name: l3-interface-ipv6-address
48607 description: IP address
48610 example: __L3-INTERFACE-IPV6-ADDRESS__
48613 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
48616 - name: interface-id
48618 description: ID of interface
48621 - name: interface-role
48623 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48626 - name: interface-id
48628 description: ID of interface
48633 description: MAC address for the interface
48636 - name: network-name
48638 description: Name of the network
48641 - name: vlan-id-inner
48643 description: Inner VLAN tag
48649 description: This indicates the customers VPN ID associated with this vlan
48652 - name: vlan-id-inner
48654 description: Inner VLAN tag
48658 - name: neutron-network-id
48660 description: Neutron network id of the interface that address belongs to
48663 - name: neutron-subnet-id
48665 description: Neutron id of subnet that address belongs to
48671 summary: create or update an existing l3-interface-ipv6-address-list
48673 Create or update an existing l3-interface-ipv6-address-list.
48675 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
48676 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48685 description: Response codes found in [response codes](https://wiki.onap.org/).
48689 description: unique name of Physical Network Function.
48692 example: __PNF-NAME__
48693 - name: interface-name
48695 description: Name that identifies the link aggregate interface
48698 example: __INTERFACE-NAME__
48699 - name: interface-name
48701 description: Name given to the interface
48704 example: __INTERFACE-NAME__
48705 - name: vlan-interface
48707 description: String that identifies the interface
48710 example: __VLAN-INTERFACE__
48711 - name: l3-interface-ipv6-address
48713 description: IP address
48716 example: __L3-INTERFACE-IPV6-ADDRESS__
48719 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
48722 $ref: "#/definitions/l3-interface-ipv6-address-list"
48726 summary: update an existing l3-interface-ipv6-address-list
48728 Update an existing l3-interface-ipv6-address-list
48730 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48731 The PUT operation will entirely replace an existing object.
48732 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
48734 Other differences between PUT and PATCH are:
48736 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
48737 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48738 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48739 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48748 description: Response codes found in [response codes](https://wiki.onap.org/).
48752 description: unique name of Physical Network Function.
48755 example: __PNF-NAME__
48756 - name: interface-name
48758 description: Name that identifies the link aggregate interface
48761 example: __INTERFACE-NAME__
48762 - name: interface-name
48764 description: Name given to the interface
48767 example: __INTERFACE-NAME__
48768 - name: vlan-interface
48770 description: String that identifies the interface
48773 example: __VLAN-INTERFACE__
48774 - name: l3-interface-ipv6-address
48776 description: IP address
48779 example: __L3-INTERFACE-IPV6-ADDRESS__
48782 description: l3-interface-ipv6-address-list object that needs to be created or updated.
48785 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
48789 summary: delete an existing l3-interface-ipv6-address-list
48790 description: delete an existing l3-interface-ipv6-address-list
48791 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48800 description: Response codes found in [response codes](https://wiki.onap.org/).
48804 description: unique name of Physical Network Function.
48807 example: __PNF-NAME__
48808 - name: interface-name
48810 description: Name that identifies the link aggregate interface
48813 example: __INTERFACE-NAME__
48814 - name: interface-name
48816 description: Name given to the interface
48819 example: __INTERFACE-NAME__
48820 - name: vlan-interface
48822 description: String that identifies the interface
48825 example: __VLAN-INTERFACE__
48826 - name: l3-interface-ipv6-address
48828 description: IP address
48831 example: __L3-INTERFACE-IPV6-ADDRESS__
48832 - name: resource-version
48834 description: resource-version for concurrency
48837 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
48841 summary: returns vlan
48842 description: returns vlan
48843 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48849 description: successful operation
48851 $ref: "#/getDefinitions/vlan"
48853 description: Response codes found in [response codes](https://wiki.onap.org/).
48857 description: unique name of Physical Network Function.
48860 example: __PNF-NAME__
48861 - name: interface-name
48863 description: Name that identifies the link aggregate interface
48866 example: __INTERFACE-NAME__
48867 - name: interface-name
48869 description: Name given to the interface
48872 example: __INTERFACE-NAME__
48873 - name: vlan-interface
48875 description: String that identifies the interface
48878 example: __VLAN-INTERFACE__
48881 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
48884 - name: interface-id
48886 description: ID of interface
48889 - name: interface-role
48891 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48894 - name: interface-id
48896 description: ID of interface
48901 description: MAC address for the interface
48904 - name: network-name
48906 description: Name of the network
48909 - name: vlan-id-inner
48911 description: Inner VLAN tag
48917 description: This indicates the customers VPN ID associated with this vlan
48923 summary: create or update an existing vlan
48925 Create or update an existing vlan.
48927 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
48928 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48937 description: Response codes found in [response codes](https://wiki.onap.org/).
48941 description: unique name of Physical Network Function.
48944 example: __PNF-NAME__
48945 - name: interface-name
48947 description: Name that identifies the link aggregate interface
48950 example: __INTERFACE-NAME__
48951 - name: interface-name
48953 description: Name given to the interface
48956 example: __INTERFACE-NAME__
48957 - name: vlan-interface
48959 description: String that identifies the interface
48962 example: __VLAN-INTERFACE__
48965 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
48968 $ref: "#/definitions/vlan"
48972 summary: update an existing vlan
48974 Update an existing vlan
48976 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48977 The PUT operation will entirely replace an existing object.
48978 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
48980 Other differences between PUT and PATCH are:
48982 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
48983 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48984 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48985 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48994 description: Response codes found in [response codes](https://wiki.onap.org/).
48998 description: unique name of Physical Network Function.
49001 example: __PNF-NAME__
49002 - name: interface-name
49004 description: Name that identifies the link aggregate interface
49007 example: __INTERFACE-NAME__
49008 - name: interface-name
49010 description: Name given to the interface
49013 example: __INTERFACE-NAME__
49014 - name: vlan-interface
49016 description: String that identifies the interface
49019 example: __VLAN-INTERFACE__
49022 description: vlan object that needs to be created or updated.
49025 $ref: "#/patchDefinitions/vlan"
49029 summary: delete an existing vlan
49030 description: delete an existing vlan
49031 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
49040 description: Response codes found in [response codes](https://wiki.onap.org/).
49044 description: unique name of Physical Network Function.
49047 example: __PNF-NAME__
49048 - name: interface-name
49050 description: Name that identifies the link aggregate interface
49053 example: __INTERFACE-NAME__
49054 - name: interface-name
49056 description: Name given to the interface
49059 example: __INTERFACE-NAME__
49060 - name: vlan-interface
49062 description: String that identifies the interface
49065 example: __VLAN-INTERFACE__
49066 - name: resource-version
49068 description: resource-version for concurrency
49071 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
49075 summary: returns vlans
49076 description: returns vlans
49077 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
49083 description: successful operation
49085 $ref: "#/getDefinitions/vlans"
49087 description: Response codes found in [response codes](https://wiki.onap.org/).
49091 description: unique name of Physical Network Function.
49094 example: __PNF-NAME__
49095 - name: interface-name
49097 description: Name that identifies the link aggregate interface
49100 example: __INTERFACE-NAME__
49101 - name: interface-name
49103 description: Name given to the interface
49106 example: __INTERFACE-NAME__
49109 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
49112 - name: interface-id
49114 description: ID of interface
49117 - name: interface-role
49119 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49122 - name: interface-id
49124 description: ID of interface
49129 description: MAC address for the interface
49132 - name: network-name
49134 description: Name of the network
49137 /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:
49141 summary: see node definition for valid relationships
49142 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
49151 description: Response codes found in [response codes](https://wiki.onap.org/).
49155 description: unique name of Physical Network Function.
49158 example: __PNF-NAME__
49159 - name: interface-name
49161 description: Name that identifies the link aggregate interface
49164 example: __INTERFACE-NAME__
49165 - name: interface-name
49167 description: Name given to the interface
49170 example: __INTERFACE-NAME__
49173 description: PCI ID used to identify the sriov-vf
49176 example: __PCI-ID__
49179 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
49182 $ref: "#/definitions/relationship"
49186 summary: delete an existing relationship
49187 description: delete an existing relationship
49188 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
49197 description: Response codes found in [response codes](https://wiki.onap.org/).
49201 description: unique name of Physical Network Function.
49204 example: __PNF-NAME__
49205 - name: interface-name
49207 description: Name that identifies the link aggregate interface
49210 example: __INTERFACE-NAME__
49211 - name: interface-name
49213 description: Name given to the interface
49216 example: __INTERFACE-NAME__
49219 description: PCI ID used to identify the sriov-vf
49222 example: __PCI-ID__
49223 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
49227 summary: returns sriov-vf
49228 description: returns sriov-vf
49229 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49235 description: successful operation
49237 $ref: "#/getDefinitions/sriov-vf"
49239 description: Response codes found in [response codes](https://wiki.onap.org/).
49243 description: unique name of Physical Network Function.
49246 example: __PNF-NAME__
49247 - name: interface-name
49249 description: Name that identifies the link aggregate interface
49252 example: __INTERFACE-NAME__
49253 - name: interface-name
49255 description: Name given to the interface
49258 example: __INTERFACE-NAME__
49261 description: PCI ID used to identify the sriov-vf
49264 example: __PCI-ID__
49267 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
49270 - name: interface-id
49272 description: ID of interface
49275 - name: interface-role
49277 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49280 - name: interface-id
49282 description: ID of interface
49287 description: MAC address for the interface
49290 - name: network-name
49292 description: Name of the network
49295 - name: vf-vlan-filter
49297 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
49300 - name: vf-mac-filter
49302 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
49305 - name: vf-vlan-strip
49307 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
49310 - name: neutron-network-id
49312 description: Neutron network id of the interface
49318 summary: create or update an existing sriov-vf
49320 Create or update an existing sriov-vf.
49322 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
49323 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49332 description: Response codes found in [response codes](https://wiki.onap.org/).
49336 description: unique name of Physical Network Function.
49339 example: __PNF-NAME__
49340 - name: interface-name
49342 description: Name that identifies the link aggregate interface
49345 example: __INTERFACE-NAME__
49346 - name: interface-name
49348 description: Name given to the interface
49351 example: __INTERFACE-NAME__
49354 description: PCI ID used to identify the sriov-vf
49357 example: __PCI-ID__
49360 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
49363 $ref: "#/definitions/sriov-vf"
49367 summary: update an existing sriov-vf
49369 Update an existing sriov-vf
49371 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49372 The PUT operation will entirely replace an existing object.
49373 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
49375 Other differences between PUT and PATCH are:
49377 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
49378 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49379 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49380 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49389 description: Response codes found in [response codes](https://wiki.onap.org/).
49393 description: unique name of Physical Network Function.
49396 example: __PNF-NAME__
49397 - name: interface-name
49399 description: Name that identifies the link aggregate interface
49402 example: __INTERFACE-NAME__
49403 - name: interface-name
49405 description: Name given to the interface
49408 example: __INTERFACE-NAME__
49411 description: PCI ID used to identify the sriov-vf
49414 example: __PCI-ID__
49417 description: sriov-vf object that needs to be created or updated.
49420 $ref: "#/patchDefinitions/sriov-vf"
49424 summary: delete an existing sriov-vf
49425 description: delete an existing sriov-vf
49426 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49435 description: Response codes found in [response codes](https://wiki.onap.org/).
49439 description: unique name of Physical Network Function.
49442 example: __PNF-NAME__
49443 - name: interface-name
49445 description: Name that identifies the link aggregate interface
49448 example: __INTERFACE-NAME__
49449 - name: interface-name
49451 description: Name given to the interface
49454 example: __INTERFACE-NAME__
49457 description: PCI ID used to identify the sriov-vf
49460 example: __PCI-ID__
49461 - name: resource-version
49463 description: resource-version for concurrency
49466 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
49470 summary: returns sriov-vfs
49471 description: returns sriov-vfs
49472 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
49478 description: successful operation
49480 $ref: "#/getDefinitions/sriov-vfs"
49482 description: Response codes found in [response codes](https://wiki.onap.org/).
49486 description: unique name of Physical Network Function.
49489 example: __PNF-NAME__
49490 - name: interface-name
49492 description: Name that identifies the link aggregate interface
49495 example: __INTERFACE-NAME__
49496 - name: interface-name
49498 description: Name given to the interface
49501 example: __INTERFACE-NAME__
49504 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
49507 - name: interface-id
49509 description: ID of interface
49512 - name: interface-role
49514 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49517 - name: interface-id
49519 description: ID of interface
49524 description: MAC address for the interface
49527 - name: network-name
49529 description: Name of the network
49532 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
49536 summary: see node definition for valid relationships
49537 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
49546 description: Response codes found in [response codes](https://wiki.onap.org/).
49550 description: unique name of Physical Network Function.
49553 example: __PNF-NAME__
49554 - name: interface-name
49556 description: Name that identifies the link aggregate interface
49559 example: __INTERFACE-NAME__
49560 - name: interface-name
49562 description: Name given to the interface
49565 example: __INTERFACE-NAME__
49568 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
49571 $ref: "#/definitions/relationship"
49575 summary: delete an existing relationship
49576 description: delete an existing relationship
49577 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
49586 description: Response codes found in [response codes](https://wiki.onap.org/).
49590 description: unique name of Physical Network Function.
49593 example: __PNF-NAME__
49594 - name: interface-name
49596 description: Name that identifies the link aggregate interface
49599 example: __INTERFACE-NAME__
49600 - name: interface-name
49602 description: Name given to the interface
49605 example: __INTERFACE-NAME__
49606 /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:
49610 summary: see node definition for valid relationships
49611 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
49620 description: Response codes found in [response codes](https://wiki.onap.org/).
49624 description: unique name of Physical Network Function.
49627 example: __PNF-NAME__
49628 - name: interface-name
49630 description: Name that identifies the link aggregate interface
49633 example: __INTERFACE-NAME__
49634 - name: interface-name
49636 description: Name given to the interface
49639 example: __INTERFACE-NAME__
49640 - name: l3-interface-ipv4-address
49642 description: IP address
49645 example: __L3-INTERFACE-IPV4-ADDRESS__
49648 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
49651 $ref: "#/definitions/relationship"
49655 summary: delete an existing relationship
49656 description: delete an existing relationship
49657 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
49666 description: Response codes found in [response codes](https://wiki.onap.org/).
49670 description: unique name of Physical Network Function.
49673 example: __PNF-NAME__
49674 - name: interface-name
49676 description: Name that identifies the link aggregate interface
49679 example: __INTERFACE-NAME__
49680 - name: interface-name
49682 description: Name given to the interface
49685 example: __INTERFACE-NAME__
49686 - name: l3-interface-ipv4-address
49688 description: IP address
49691 example: __L3-INTERFACE-IPV4-ADDRESS__
49692 /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}:
49696 summary: returns l3-interface-ipv4-address-list
49697 description: returns l3-interface-ipv4-address-list
49698 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49704 description: successful operation
49706 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
49708 description: Response codes found in [response codes](https://wiki.onap.org/).
49712 description: unique name of Physical Network Function.
49715 example: __PNF-NAME__
49716 - name: interface-name
49718 description: Name that identifies the link aggregate interface
49721 example: __INTERFACE-NAME__
49722 - name: interface-name
49724 description: Name given to the interface
49727 example: __INTERFACE-NAME__
49728 - name: l3-interface-ipv4-address
49730 description: IP address
49733 example: __L3-INTERFACE-IPV4-ADDRESS__
49736 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
49739 - name: interface-id
49741 description: ID of interface
49744 - name: interface-role
49746 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49749 - name: interface-id
49751 description: ID of interface
49756 description: MAC address for the interface
49759 - name: network-name
49761 description: Name of the network
49764 - name: vlan-id-inner
49766 description: Inner VLAN tag
49770 - name: neutron-network-id
49772 description: Neutron network id of the interface that address belongs to
49775 - name: neutron-subnet-id
49777 description: Neutron id of subnet that address belongs to
49783 summary: create or update an existing l3-interface-ipv4-address-list
49785 Create or update an existing l3-interface-ipv4-address-list.
49787 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
49788 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49797 description: Response codes found in [response codes](https://wiki.onap.org/).
49801 description: unique name of Physical Network Function.
49804 example: __PNF-NAME__
49805 - name: interface-name
49807 description: Name that identifies the link aggregate interface
49810 example: __INTERFACE-NAME__
49811 - name: interface-name
49813 description: Name given to the interface
49816 example: __INTERFACE-NAME__
49817 - name: l3-interface-ipv4-address
49819 description: IP address
49822 example: __L3-INTERFACE-IPV4-ADDRESS__
49825 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
49828 $ref: "#/definitions/l3-interface-ipv4-address-list"
49832 summary: update an existing l3-interface-ipv4-address-list
49834 Update an existing l3-interface-ipv4-address-list
49836 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49837 The PUT operation will entirely replace an existing object.
49838 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
49840 Other differences between PUT and PATCH are:
49842 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
49843 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49844 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49845 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49854 description: Response codes found in [response codes](https://wiki.onap.org/).
49858 description: unique name of Physical Network Function.
49861 example: __PNF-NAME__
49862 - name: interface-name
49864 description: Name that identifies the link aggregate interface
49867 example: __INTERFACE-NAME__
49868 - name: interface-name
49870 description: Name given to the interface
49873 example: __INTERFACE-NAME__
49874 - name: l3-interface-ipv4-address
49876 description: IP address
49879 example: __L3-INTERFACE-IPV4-ADDRESS__
49882 description: l3-interface-ipv4-address-list object that needs to be created or updated.
49885 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
49889 summary: delete an existing l3-interface-ipv4-address-list
49890 description: delete an existing l3-interface-ipv4-address-list
49891 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49900 description: Response codes found in [response codes](https://wiki.onap.org/).
49904 description: unique name of Physical Network Function.
49907 example: __PNF-NAME__
49908 - name: interface-name
49910 description: Name that identifies the link aggregate interface
49913 example: __INTERFACE-NAME__
49914 - name: interface-name
49916 description: Name given to the interface
49919 example: __INTERFACE-NAME__
49920 - name: l3-interface-ipv4-address
49922 description: IP address
49925 example: __L3-INTERFACE-IPV4-ADDRESS__
49926 - name: resource-version
49928 description: resource-version for concurrency
49931 /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:
49935 summary: see node definition for valid relationships
49936 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
49945 description: Response codes found in [response codes](https://wiki.onap.org/).
49949 description: unique name of Physical Network Function.
49952 example: __PNF-NAME__
49953 - name: interface-name
49955 description: Name that identifies the link aggregate interface
49958 example: __INTERFACE-NAME__
49959 - name: interface-name
49961 description: Name given to the interface
49964 example: __INTERFACE-NAME__
49965 - name: l3-interface-ipv6-address
49967 description: IP address
49970 example: __L3-INTERFACE-IPV6-ADDRESS__
49973 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
49976 $ref: "#/definitions/relationship"
49980 summary: delete an existing relationship
49981 description: delete an existing relationship
49982 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
49991 description: Response codes found in [response codes](https://wiki.onap.org/).
49995 description: unique name of Physical Network Function.
49998 example: __PNF-NAME__
49999 - name: interface-name
50001 description: Name that identifies the link aggregate interface
50004 example: __INTERFACE-NAME__
50005 - name: interface-name
50007 description: Name given to the interface
50010 example: __INTERFACE-NAME__
50011 - name: l3-interface-ipv6-address
50013 description: IP address
50016 example: __L3-INTERFACE-IPV6-ADDRESS__
50017 /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}:
50021 summary: returns l3-interface-ipv6-address-list
50022 description: returns l3-interface-ipv6-address-list
50023 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50029 description: successful operation
50031 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
50033 description: Response codes found in [response codes](https://wiki.onap.org/).
50037 description: unique name of Physical Network Function.
50040 example: __PNF-NAME__
50041 - name: interface-name
50043 description: Name that identifies the link aggregate interface
50046 example: __INTERFACE-NAME__
50047 - name: interface-name
50049 description: Name given to the interface
50052 example: __INTERFACE-NAME__
50053 - name: l3-interface-ipv6-address
50055 description: IP address
50058 example: __L3-INTERFACE-IPV6-ADDRESS__
50061 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50064 - name: interface-id
50066 description: ID of interface
50069 - name: interface-role
50071 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50074 - name: interface-id
50076 description: ID of interface
50081 description: MAC address for the interface
50084 - name: network-name
50086 description: Name of the network
50089 - name: vlan-id-inner
50091 description: Inner VLAN tag
50095 - name: neutron-network-id
50097 description: Neutron network id of the interface that address belongs to
50100 - name: neutron-subnet-id
50102 description: Neutron id of subnet that address belongs to
50108 summary: create or update an existing l3-interface-ipv6-address-list
50110 Create or update an existing l3-interface-ipv6-address-list.
50112 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
50113 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50122 description: Response codes found in [response codes](https://wiki.onap.org/).
50126 description: unique name of Physical Network Function.
50129 example: __PNF-NAME__
50130 - name: interface-name
50132 description: Name that identifies the link aggregate interface
50135 example: __INTERFACE-NAME__
50136 - name: interface-name
50138 description: Name given to the interface
50141 example: __INTERFACE-NAME__
50142 - name: l3-interface-ipv6-address
50144 description: IP address
50147 example: __L3-INTERFACE-IPV6-ADDRESS__
50150 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
50153 $ref: "#/definitions/l3-interface-ipv6-address-list"
50157 summary: update an existing l3-interface-ipv6-address-list
50159 Update an existing l3-interface-ipv6-address-list
50161 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50162 The PUT operation will entirely replace an existing object.
50163 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
50165 Other differences between PUT and PATCH are:
50167 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
50168 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50169 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50170 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50179 description: Response codes found in [response codes](https://wiki.onap.org/).
50183 description: unique name of Physical Network Function.
50186 example: __PNF-NAME__
50187 - name: interface-name
50189 description: Name that identifies the link aggregate interface
50192 example: __INTERFACE-NAME__
50193 - name: interface-name
50195 description: Name given to the interface
50198 example: __INTERFACE-NAME__
50199 - name: l3-interface-ipv6-address
50201 description: IP address
50204 example: __L3-INTERFACE-IPV6-ADDRESS__
50207 description: l3-interface-ipv6-address-list object that needs to be created or updated.
50210 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
50214 summary: delete an existing l3-interface-ipv6-address-list
50215 description: delete an existing l3-interface-ipv6-address-list
50216 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50225 description: Response codes found in [response codes](https://wiki.onap.org/).
50229 description: unique name of Physical Network Function.
50232 example: __PNF-NAME__
50233 - name: interface-name
50235 description: Name that identifies the link aggregate interface
50238 example: __INTERFACE-NAME__
50239 - name: interface-name
50241 description: Name given to the interface
50244 example: __INTERFACE-NAME__
50245 - name: l3-interface-ipv6-address
50247 description: IP address
50250 example: __L3-INTERFACE-IPV6-ADDRESS__
50251 - name: resource-version
50253 description: resource-version for concurrency
50256 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
50260 summary: returns l-interface
50261 description: returns l-interface
50262 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50268 description: successful operation
50270 $ref: "#/getDefinitions/l-interface"
50272 description: Response codes found in [response codes](https://wiki.onap.org/).
50276 description: unique name of Physical Network Function.
50279 example: __PNF-NAME__
50280 - name: interface-name
50282 description: Name that identifies the link aggregate interface
50285 example: __INTERFACE-NAME__
50286 - name: interface-name
50288 description: Name given to the interface
50291 example: __INTERFACE-NAME__
50294 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50297 - name: interface-id
50299 description: ID of interface
50302 - name: interface-role
50304 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50307 - name: interface-id
50309 description: ID of interface
50314 description: MAC address for the interface
50317 - name: network-name
50319 description: Name of the network
50325 summary: create or update an existing l-interface
50327 Create or update an existing l-interface.
50329 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
50330 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50339 description: Response codes found in [response codes](https://wiki.onap.org/).
50343 description: unique name of Physical Network Function.
50346 example: __PNF-NAME__
50347 - name: interface-name
50349 description: Name that identifies the link aggregate interface
50352 example: __INTERFACE-NAME__
50353 - name: interface-name
50355 description: Name given to the interface
50358 example: __INTERFACE-NAME__
50361 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
50364 $ref: "#/definitions/l-interface"
50368 summary: update an existing l-interface
50370 Update an existing l-interface
50372 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50373 The PUT operation will entirely replace an existing object.
50374 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
50376 Other differences between PUT and PATCH are:
50378 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
50379 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50380 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50381 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50390 description: Response codes found in [response codes](https://wiki.onap.org/).
50394 description: unique name of Physical Network Function.
50397 example: __PNF-NAME__
50398 - name: interface-name
50400 description: Name that identifies the link aggregate interface
50403 example: __INTERFACE-NAME__
50404 - name: interface-name
50406 description: Name given to the interface
50409 example: __INTERFACE-NAME__
50412 description: l-interface object that needs to be created or updated.
50415 $ref: "#/patchDefinitions/l-interface"
50419 summary: delete an existing l-interface
50420 description: delete an existing l-interface
50421 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50430 description: Response codes found in [response codes](https://wiki.onap.org/).
50434 description: unique name of Physical Network Function.
50437 example: __PNF-NAME__
50438 - name: interface-name
50440 description: Name that identifies the link aggregate interface
50443 example: __INTERFACE-NAME__
50444 - name: interface-name
50446 description: Name given to the interface
50449 example: __INTERFACE-NAME__
50450 - name: resource-version
50452 description: resource-version for concurrency
50455 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
50459 summary: returns l-interfaces
50460 description: returns l-interfaces
50461 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
50467 description: successful operation
50469 $ref: "#/getDefinitions/l-interfaces"
50471 description: Response codes found in [response codes](https://wiki.onap.org/).
50475 description: unique name of Physical Network Function.
50478 example: __PNF-NAME__
50479 - name: interface-name
50481 description: Name that identifies the link aggregate interface
50484 example: __INTERFACE-NAME__
50487 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50490 - name: interface-id
50492 description: ID of interface
50495 - name: interface-role
50497 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50500 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
50504 summary: returns lag-interface
50505 description: returns lag-interface
50506 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
50512 description: successful operation
50514 $ref: "#/getDefinitions/lag-interface"
50516 description: Response codes found in [response codes](https://wiki.onap.org/).
50520 description: unique name of Physical Network Function.
50523 example: __PNF-NAME__
50524 - name: interface-name
50526 description: Name that identifies the link aggregate interface
50529 example: __INTERFACE-NAME__
50532 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50535 - name: interface-id
50537 description: ID of interface
50540 - name: interface-role
50542 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50548 summary: create or update an existing lag-interface
50550 Create or update an existing lag-interface.
50552 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
50553 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
50562 description: Response codes found in [response codes](https://wiki.onap.org/).
50566 description: unique name of Physical Network Function.
50569 example: __PNF-NAME__
50570 - name: interface-name
50572 description: Name that identifies the link aggregate interface
50575 example: __INTERFACE-NAME__
50578 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)
50581 $ref: "#/definitions/lag-interface"
50585 summary: update an existing lag-interface
50587 Update an existing lag-interface
50589 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50590 The PUT operation will entirely replace an existing object.
50591 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
50593 Other differences between PUT and PATCH are:
50595 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
50596 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50597 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50598 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
50607 description: Response codes found in [response codes](https://wiki.onap.org/).
50611 description: unique name of Physical Network Function.
50614 example: __PNF-NAME__
50615 - name: interface-name
50617 description: Name that identifies the link aggregate interface
50620 example: __INTERFACE-NAME__
50623 description: lag-interface object that needs to be created or updated.
50626 $ref: "#/patchDefinitions/lag-interface"
50630 summary: delete an existing lag-interface
50631 description: delete an existing lag-interface
50632 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
50641 description: Response codes found in [response codes](https://wiki.onap.org/).
50645 description: unique name of Physical Network Function.
50648 example: __PNF-NAME__
50649 - name: interface-name
50651 description: Name that identifies the link aggregate interface
50654 example: __INTERFACE-NAME__
50655 - name: resource-version
50657 description: resource-version for concurrency
50660 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
50664 summary: returns lag-interfaces
50665 description: returns lag-interfaces
50666 operationId: getNetworkPnfsPnfLagInterfaces
50672 description: successful operation
50674 $ref: "#/getDefinitions/lag-interfaces"
50676 description: Response codes found in [response codes](https://wiki.onap.org/).
50680 description: unique name of Physical Network Function.
50683 example: __PNF-NAME__
50686 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50689 /network/pnfs/pnf/{pnf-name}:
50693 summary: returns pnf
50694 description: returns pnf
50695 operationId: getNetworkPnfsPnf
50701 description: successful operation
50703 $ref: "#/getDefinitions/pnf"
50705 description: Response codes found in [response codes](https://wiki.onap.org/).
50709 description: unique name of Physical Network Function.
50712 example: __PNF-NAME__
50715 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50721 summary: create or update an existing pnf
50723 Create or update an existing pnf.
50725 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
50726 operationId: createOrUpdateNetworkPnfsPnf
50735 description: Response codes found in [response codes](https://wiki.onap.org/).
50739 description: unique name of Physical Network Function.
50742 example: __PNF-NAME__
50745 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)
50748 $ref: "#/definitions/pnf"
50752 summary: update an existing pnf
50754 Update an existing pnf
50756 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50757 The PUT operation will entirely replace an existing object.
50758 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
50760 Other differences between PUT and PATCH are:
50762 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
50763 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50764 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50765 operationId: UpdateNetworkPnfsPnf
50774 description: Response codes found in [response codes](https://wiki.onap.org/).
50778 description: unique name of Physical Network Function.
50781 example: __PNF-NAME__
50784 description: pnf object that needs to be created or updated.
50787 $ref: "#/patchDefinitions/pnf"
50791 summary: delete an existing pnf
50792 description: delete an existing pnf
50793 operationId: deleteNetworkPnfsPnf
50802 description: Response codes found in [response codes](https://wiki.onap.org/).
50806 description: unique name of Physical Network Function.
50809 example: __PNF-NAME__
50810 - name: resource-version
50812 description: resource-version for concurrency
50819 summary: returns pnfs
50820 description: returns pnfs
50821 operationId: getNetworkPnfs
50827 description: successful operation
50829 $ref: "#/getDefinitions/pnfs"
50831 description: Response codes found in [response codes](https://wiki.onap.org/).
50832 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
50836 summary: see node definition for valid relationships
50837 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
50846 description: Response codes found in [response codes](https://wiki.onap.org/).
50850 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50853 example: __LINK-NAME__
50856 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)
50859 $ref: "#/definitions/relationship"
50863 summary: delete an existing relationship
50864 description: delete an existing relationship
50865 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
50874 description: Response codes found in [response codes](https://wiki.onap.org/).
50878 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50881 example: __LINK-NAME__
50882 /network/physical-links/physical-link/{link-name}:
50886 summary: returns physical-link
50887 description: returns physical-link
50888 operationId: getNetworkPhysicalLinksPhysicalLink
50894 description: successful operation
50896 $ref: "#/getDefinitions/physical-link"
50898 description: Response codes found in [response codes](https://wiki.onap.org/).
50902 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50905 example: __LINK-NAME__
50908 description: Circuit it
50914 summary: create or update an existing physical-link
50916 Create or update an existing physical-link.
50918 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
50919 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
50928 description: Response codes found in [response codes](https://wiki.onap.org/).
50932 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50935 example: __LINK-NAME__
50938 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)
50941 $ref: "#/definitions/physical-link"
50945 summary: update an existing physical-link
50947 Update an existing physical-link
50949 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50950 The PUT operation will entirely replace an existing object.
50951 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
50953 Other differences between PUT and PATCH are:
50955 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
50956 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50957 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50958 operationId: UpdateNetworkPhysicalLinksPhysicalLink
50967 description: Response codes found in [response codes](https://wiki.onap.org/).
50971 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50974 example: __LINK-NAME__
50977 description: physical-link object that needs to be created or updated.
50980 $ref: "#/patchDefinitions/physical-link"
50984 summary: delete an existing physical-link
50985 description: delete an existing physical-link
50986 operationId: deleteNetworkPhysicalLinksPhysicalLink
50995 description: Response codes found in [response codes](https://wiki.onap.org/).
50999 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51002 example: __LINK-NAME__
51003 - name: resource-version
51005 description: resource-version for concurrency
51008 /network/physical-links:
51012 summary: returns physical-links
51013 description: returns physical-links
51014 operationId: getNetworkPhysicalLinks
51020 description: successful operation
51022 $ref: "#/getDefinitions/physical-links"
51024 description: Response codes found in [response codes](https://wiki.onap.org/).
51025 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
51029 summary: see node definition for valid relationships
51030 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
51039 description: Response codes found in [response codes](https://wiki.onap.org/).
51041 - name: ipsec-configuration-id
51043 description: UUID of this configuration
51046 example: __IPSEC-CONFIGURATION-ID__
51049 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)
51052 $ref: "#/definitions/relationship"
51056 summary: delete an existing relationship
51057 description: delete an existing relationship
51058 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
51067 description: Response codes found in [response codes](https://wiki.onap.org/).
51069 - name: ipsec-configuration-id
51071 description: UUID of this configuration
51074 example: __IPSEC-CONFIGURATION-ID__
51075 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
51079 summary: see node definition for valid relationships
51080 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
51089 description: Response codes found in [response codes](https://wiki.onap.org/).
51091 - name: ipsec-configuration-id
51093 description: UUID of this configuration
51096 example: __IPSEC-CONFIGURATION-ID__
51097 - name: vig-address-type
51099 description: indicates whether the VIG is for AVPN or INTERNET
51102 example: __VIG-ADDRESS-TYPE__
51105 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
51108 $ref: "#/definitions/relationship"
51112 summary: delete an existing relationship
51113 description: delete an existing relationship
51114 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
51123 description: Response codes found in [response codes](https://wiki.onap.org/).
51125 - name: ipsec-configuration-id
51127 description: UUID of this configuration
51130 example: __IPSEC-CONFIGURATION-ID__
51131 - name: vig-address-type
51133 description: indicates whether the VIG is for AVPN or INTERNET
51136 example: __VIG-ADDRESS-TYPE__
51137 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
51141 summary: returns vig-server
51142 description: returns vig-server
51143 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51149 description: successful operation
51151 $ref: "#/getDefinitions/vig-server"
51153 description: Response codes found in [response codes](https://wiki.onap.org/).
51155 - name: ipsec-configuration-id
51157 description: UUID of this configuration
51160 example: __IPSEC-CONFIGURATION-ID__
51161 - name: vig-address-type
51163 description: indicates whether the VIG is for AVPN or INTERNET
51166 example: __VIG-ADDRESS-TYPE__
51170 summary: create or update an existing vig-server
51172 Create or update an existing vig-server.
51174 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
51175 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51184 description: Response codes found in [response codes](https://wiki.onap.org/).
51186 - name: ipsec-configuration-id
51188 description: UUID of this configuration
51191 example: __IPSEC-CONFIGURATION-ID__
51192 - name: vig-address-type
51194 description: indicates whether the VIG is for AVPN or INTERNET
51197 example: __VIG-ADDRESS-TYPE__
51200 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
51203 $ref: "#/definitions/vig-server"
51207 summary: update an existing vig-server
51209 Update an existing vig-server
51211 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51212 The PUT operation will entirely replace an existing object.
51213 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
51215 Other differences between PUT and PATCH are:
51217 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
51218 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51219 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51220 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51229 description: Response codes found in [response codes](https://wiki.onap.org/).
51231 - name: ipsec-configuration-id
51233 description: UUID of this configuration
51236 example: __IPSEC-CONFIGURATION-ID__
51237 - name: vig-address-type
51239 description: indicates whether the VIG is for AVPN or INTERNET
51242 example: __VIG-ADDRESS-TYPE__
51245 description: vig-server object that needs to be created or updated.
51248 $ref: "#/patchDefinitions/vig-server"
51252 summary: delete an existing vig-server
51253 description: delete an existing vig-server
51254 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51263 description: Response codes found in [response codes](https://wiki.onap.org/).
51265 - name: ipsec-configuration-id
51267 description: UUID of this configuration
51270 example: __IPSEC-CONFIGURATION-ID__
51271 - name: vig-address-type
51273 description: indicates whether the VIG is for AVPN or INTERNET
51276 example: __VIG-ADDRESS-TYPE__
51277 - name: resource-version
51279 description: resource-version for concurrency
51282 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
51286 summary: returns vig-servers
51287 description: returns vig-servers
51288 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
51294 description: successful operation
51296 $ref: "#/getDefinitions/vig-servers"
51298 description: Response codes found in [response codes](https://wiki.onap.org/).
51300 - name: ipsec-configuration-id
51302 description: UUID of this configuration
51305 example: __IPSEC-CONFIGURATION-ID__
51306 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
51310 summary: returns ipsec-configuration
51311 description: returns ipsec-configuration
51312 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
51318 description: successful operation
51320 $ref: "#/getDefinitions/ipsec-configuration"
51322 description: Response codes found in [response codes](https://wiki.onap.org/).
51324 - name: ipsec-configuration-id
51326 description: UUID of this configuration
51329 example: __IPSEC-CONFIGURATION-ID__
51333 summary: create or update an existing ipsec-configuration
51335 Create or update an existing ipsec-configuration.
51337 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
51338 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
51347 description: Response codes found in [response codes](https://wiki.onap.org/).
51349 - name: ipsec-configuration-id
51351 description: UUID of this configuration
51354 example: __IPSEC-CONFIGURATION-ID__
51357 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)
51360 $ref: "#/definitions/ipsec-configuration"
51364 summary: update an existing ipsec-configuration
51366 Update an existing ipsec-configuration
51368 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51369 The PUT operation will entirely replace an existing object.
51370 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
51372 Other differences between PUT and PATCH are:
51374 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
51375 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51376 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51377 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
51386 description: Response codes found in [response codes](https://wiki.onap.org/).
51388 - name: ipsec-configuration-id
51390 description: UUID of this configuration
51393 example: __IPSEC-CONFIGURATION-ID__
51396 description: ipsec-configuration object that needs to be created or updated.
51399 $ref: "#/patchDefinitions/ipsec-configuration"
51403 summary: delete an existing ipsec-configuration
51404 description: delete an existing ipsec-configuration
51405 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
51414 description: Response codes found in [response codes](https://wiki.onap.org/).
51416 - name: ipsec-configuration-id
51418 description: UUID of this configuration
51421 example: __IPSEC-CONFIGURATION-ID__
51422 - name: resource-version
51424 description: resource-version for concurrency
51427 /network/ipsec-configurations:
51431 summary: returns ipsec-configurations
51432 description: returns ipsec-configurations
51433 operationId: getNetworkIpsecConfigurations
51439 description: successful operation
51441 $ref: "#/getDefinitions/ipsec-configurations"
51443 description: Response codes found in [response codes](https://wiki.onap.org/).
51444 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
51448 summary: see node definition for valid relationships
51449 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
51458 description: Response codes found in [response codes](https://wiki.onap.org/).
51460 - name: route-table-reference-id
51462 description: Route Table Reference id, UUID assigned to this instance.
51465 example: __ROUTE-TABLE-REFERENCE-ID__
51468 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)
51471 $ref: "#/definitions/relationship"
51475 summary: delete an existing relationship
51476 description: delete an existing relationship
51477 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
51486 description: Response codes found in [response codes](https://wiki.onap.org/).
51488 - name: route-table-reference-id
51490 description: Route Table Reference id, UUID assigned to this instance.
51493 example: __ROUTE-TABLE-REFERENCE-ID__
51494 /network/route-table-references/route-table-reference/{route-table-reference-id}:
51498 summary: returns route-table-reference
51499 description: returns route-table-reference
51500 operationId: getNetworkRouteTableReferencesRouteTableReference
51506 description: successful operation
51508 $ref: "#/getDefinitions/route-table-reference"
51510 description: Response codes found in [response codes](https://wiki.onap.org/).
51512 - name: route-table-reference-id
51514 description: Route Table Reference id, UUID assigned to this instance.
51517 example: __ROUTE-TABLE-REFERENCE-ID__
51518 - name: route-table-reference-fqdn
51520 description: FQDN entry in the route table.
51526 summary: create or update an existing route-table-reference
51528 Create or update an existing route-table-reference.
51530 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
51531 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
51540 description: Response codes found in [response codes](https://wiki.onap.org/).
51542 - name: route-table-reference-id
51544 description: Route Table Reference id, UUID assigned to this instance.
51547 example: __ROUTE-TABLE-REFERENCE-ID__
51550 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)
51553 $ref: "#/definitions/route-table-reference"
51557 summary: update an existing route-table-reference
51559 Update an existing route-table-reference
51561 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51562 The PUT operation will entirely replace an existing object.
51563 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
51565 Other differences between PUT and PATCH are:
51567 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
51568 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51569 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51570 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
51579 description: Response codes found in [response codes](https://wiki.onap.org/).
51581 - name: route-table-reference-id
51583 description: Route Table Reference id, UUID assigned to this instance.
51586 example: __ROUTE-TABLE-REFERENCE-ID__
51589 description: route-table-reference object that needs to be created or updated.
51592 $ref: "#/patchDefinitions/route-table-reference"
51596 summary: delete an existing route-table-reference
51597 description: delete an existing route-table-reference
51598 operationId: deleteNetworkRouteTableReferencesRouteTableReference
51607 description: Response codes found in [response codes](https://wiki.onap.org/).
51609 - name: route-table-reference-id
51611 description: Route Table Reference id, UUID assigned to this instance.
51614 example: __ROUTE-TABLE-REFERENCE-ID__
51615 - name: resource-version
51617 description: resource-version for concurrency
51620 /network/route-table-references:
51624 summary: returns route-table-references
51625 description: returns route-table-references
51626 operationId: getNetworkRouteTableReferences
51632 description: successful operation
51634 $ref: "#/getDefinitions/route-table-references"
51636 description: Response codes found in [response codes](https://wiki.onap.org/).
51637 /network/instance-groups/instance-group/{id}/relationship-list/relationship:
51641 summary: see node definition for valid relationships
51642 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
51651 description: Response codes found in [response codes](https://wiki.onap.org/).
51655 description: Instance Group ID, UUID assigned to this instance.
51661 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)
51664 $ref: "#/definitions/relationship"
51668 summary: delete an existing relationship
51669 description: delete an existing relationship
51670 operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
51679 description: Response codes found in [response codes](https://wiki.onap.org/).
51683 description: Instance Group ID, UUID assigned to this instance.
51687 /network/instance-groups/instance-group/{id}:
51691 summary: returns instance-group
51692 description: returns instance-group
51693 operationId: getNetworkInstanceGroupsInstanceGroup
51699 description: successful operation
51701 $ref: "#/getDefinitions/instance-group"
51703 description: Response codes found in [response codes](https://wiki.onap.org/).
51707 description: Instance Group ID, UUID assigned to this instance.
51711 - name: description
51713 description: Descriptive text to help identify the usage of this instance-group
51718 description: Only valid value today is lower case ha for high availability
51723 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
51729 summary: create or update an existing instance-group
51731 Create or update an existing instance-group.
51733 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
51734 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
51743 description: Response codes found in [response codes](https://wiki.onap.org/).
51747 description: Instance Group ID, UUID assigned to this instance.
51753 description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)
51756 $ref: "#/definitions/instance-group"
51760 summary: update an existing instance-group
51762 Update an existing instance-group
51764 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51765 The PUT operation will entirely replace an existing object.
51766 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
51768 Other differences between PUT and PATCH are:
51770 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
51771 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51772 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51773 operationId: UpdateNetworkInstanceGroupsInstanceGroup
51782 description: Response codes found in [response codes](https://wiki.onap.org/).
51786 description: Instance Group ID, UUID assigned to this instance.
51792 description: instance-group object that needs to be created or updated.
51795 $ref: "#/patchDefinitions/instance-group"
51799 summary: delete an existing instance-group
51800 description: delete an existing instance-group
51801 operationId: deleteNetworkInstanceGroupsInstanceGroup
51810 description: Response codes found in [response codes](https://wiki.onap.org/).
51814 description: Instance Group ID, UUID assigned to this instance.
51818 - name: resource-version
51820 description: resource-version for concurrency
51823 /network/instance-groups:
51827 summary: returns instance-groups
51828 description: returns instance-groups
51829 operationId: getNetworkInstanceGroups
51835 description: successful operation
51837 $ref: "#/getDefinitions/instance-groups"
51839 description: Response codes found in [response codes](https://wiki.onap.org/).
51840 /network/zones/zone/{zone-id}/relationship-list/relationship:
51844 summary: see node definition for valid relationships
51845 operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
51854 description: Response codes found in [response codes](https://wiki.onap.org/).
51858 description: Code assigned by AIC to the zone
51861 example: __ZONE-ID__
51864 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)
51867 $ref: "#/definitions/relationship"
51871 summary: delete an existing relationship
51872 description: delete an existing relationship
51873 operationId: deleteNetworkZonesZoneRelationshipListRelationship
51882 description: Response codes found in [response codes](https://wiki.onap.org/).
51886 description: Code assigned by AIC to the zone
51889 example: __ZONE-ID__
51890 /network/zones/zone/{zone-id}:
51894 summary: returns zone
51895 description: returns zone
51896 operationId: getNetworkZonesZone
51902 description: successful operation
51904 $ref: "#/getDefinitions/zone"
51906 description: Response codes found in [response codes](https://wiki.onap.org/).
51910 description: Code assigned by AIC to the zone
51913 example: __ZONE-ID__
51914 - name: design-type
51916 description: Design of zone [Medium/Large?]
51919 - name: zone-context
51921 description: Context of zone [production/test]
51927 summary: create or update an existing zone
51929 Create or update an existing zone.
51931 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
51932 operationId: createOrUpdateNetworkZonesZone
51941 description: Response codes found in [response codes](https://wiki.onap.org/).
51945 description: Code assigned by AIC to the zone
51948 example: __ZONE-ID__
51951 description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)
51954 $ref: "#/definitions/zone"
51958 summary: update an existing zone
51960 Update an existing zone
51962 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51963 The PUT operation will entirely replace an existing object.
51964 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
51966 Other differences between PUT and PATCH are:
51968 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
51969 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51970 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51971 operationId: UpdateNetworkZonesZone
51980 description: Response codes found in [response codes](https://wiki.onap.org/).
51984 description: Code assigned by AIC to the zone
51987 example: __ZONE-ID__
51990 description: zone object that needs to be created or updated.
51993 $ref: "#/patchDefinitions/zone"
51997 summary: delete an existing zone
51998 description: delete an existing zone
51999 operationId: deleteNetworkZonesZone
52008 description: Response codes found in [response codes](https://wiki.onap.org/).
52012 description: Code assigned by AIC to the zone
52015 example: __ZONE-ID__
52016 - name: resource-version
52018 description: resource-version for concurrency
52025 summary: returns zones
52026 description: returns zones
52027 operationId: getNetworkZones
52033 description: successful operation
52035 $ref: "#/getDefinitions/zones"
52037 description: Response codes found in [response codes](https://wiki.onap.org/).
52038 /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
52042 summary: see node definition for valid relationships
52043 operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
52052 description: Response codes found in [response codes](https://wiki.onap.org/).
52054 - name: configuration-id
52056 description: UUID assigned to configuration.
52059 example: __CONFIGURATION-ID__
52062 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)
52065 $ref: "#/definitions/relationship"
52069 summary: delete an existing relationship
52070 description: delete an existing relationship
52071 operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
52080 description: Response codes found in [response codes](https://wiki.onap.org/).
52082 - name: configuration-id
52084 description: UUID assigned to configuration.
52087 example: __CONFIGURATION-ID__
52088 /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
52092 summary: returns metadatum
52093 description: returns metadatum
52094 operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
52100 description: successful operation
52102 $ref: "#/getDefinitions/metadatum"
52104 description: Response codes found in [response codes](https://wiki.onap.org/).
52106 - name: configuration-id
52108 description: UUID assigned to configuration.
52111 example: __CONFIGURATION-ID__
52116 example: __METANAME__
52117 - name: model-invariant-id
52119 description: the ASDC model id for this resource or service model.
52122 - name: model-version-id
52124 description: the ASDC model version for this resource or service model.
52130 summary: create or update an existing metadatum
52132 Create or update an existing metadatum.
52134 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
52135 operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
52144 description: Response codes found in [response codes](https://wiki.onap.org/).
52146 - name: configuration-id
52148 description: UUID assigned to configuration.
52151 example: __CONFIGURATION-ID__
52156 example: __METANAME__
52159 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfigurationMetadataMetadatum.json)
52162 $ref: "#/definitions/metadatum"
52166 summary: update an existing metadatum
52168 Update an existing metadatum
52170 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52171 The PUT operation will entirely replace an existing object.
52172 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
52174 Other differences between PUT and PATCH are:
52176 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
52177 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52178 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52179 operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
52188 description: Response codes found in [response codes](https://wiki.onap.org/).
52190 - name: configuration-id
52192 description: UUID assigned to configuration.
52195 example: __CONFIGURATION-ID__
52200 example: __METANAME__
52203 description: metadatum object that needs to be created or updated.
52206 $ref: "#/patchDefinitions/metadatum"
52210 summary: delete an existing metadatum
52211 description: delete an existing metadatum
52212 operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
52221 description: Response codes found in [response codes](https://wiki.onap.org/).
52223 - name: configuration-id
52225 description: UUID assigned to configuration.
52228 example: __CONFIGURATION-ID__
52233 example: __METANAME__
52234 - name: resource-version
52236 description: resource-version for concurrency
52239 /network/configurations/configuration/{configuration-id}/metadata:
52243 summary: returns metadata
52244 description: returns metadata
52245 operationId: getNetworkConfigurationsConfigurationMetadata
52251 description: successful operation
52253 $ref: "#/getDefinitions/metadata"
52255 description: Response codes found in [response codes](https://wiki.onap.org/).
52257 - name: configuration-id
52259 description: UUID assigned to configuration.
52262 example: __CONFIGURATION-ID__
52263 - name: model-invariant-id
52265 description: the ASDC model id for this resource or service model.
52268 - name: model-version-id
52270 description: the ASDC model version for this resource or service model.
52273 /network/configurations/configuration/{configuration-id}:
52277 summary: returns configuration
52278 description: returns configuration
52279 operationId: getNetworkConfigurationsConfiguration
52285 description: successful operation
52287 $ref: "#/getDefinitions/configuration"
52289 description: Response codes found in [response codes](https://wiki.onap.org/).
52291 - name: configuration-id
52293 description: UUID assigned to configuration.
52296 example: __CONFIGURATION-ID__
52297 - name: model-invariant-id
52299 description: the ASDC model id for this resource or service model.
52302 - name: model-version-id
52304 description: the ASDC model version for this resource or service model.
52310 summary: create or update an existing configuration
52312 Create or update an existing configuration.
52314 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
52315 operationId: createOrUpdateNetworkConfigurationsConfiguration
52324 description: Response codes found in [response codes](https://wiki.onap.org/).
52326 - name: configuration-id
52328 description: UUID assigned to configuration.
52331 example: __CONFIGURATION-ID__
52334 description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)
52337 $ref: "#/definitions/configuration"
52341 summary: update an existing configuration
52343 Update an existing configuration
52345 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52346 The PUT operation will entirely replace an existing object.
52347 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
52349 Other differences between PUT and PATCH are:
52351 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
52352 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52353 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52354 operationId: UpdateNetworkConfigurationsConfiguration
52363 description: Response codes found in [response codes](https://wiki.onap.org/).
52365 - name: configuration-id
52367 description: UUID assigned to configuration.
52370 example: __CONFIGURATION-ID__
52373 description: configuration object that needs to be created or updated.
52376 $ref: "#/patchDefinitions/configuration"
52380 summary: delete an existing configuration
52381 description: delete an existing configuration
52382 operationId: deleteNetworkConfigurationsConfiguration
52391 description: Response codes found in [response codes](https://wiki.onap.org/).
52393 - name: configuration-id
52395 description: UUID assigned to configuration.
52398 example: __CONFIGURATION-ID__
52399 - name: resource-version
52401 description: resource-version for concurrency
52404 /network/configurations:
52408 summary: returns configurations
52409 description: returns configurations
52410 operationId: getNetworkConfigurations
52416 description: successful operation
52418 $ref: "#/getDefinitions/configurations"
52420 description: Response codes found in [response codes](https://wiki.onap.org/).
52435 $ref: "#/definitions/action-data"
52444 APIs that are more action related than REST (e.g., notify, update).
52448 $ref: "#/definitions/update"
52451 $ref: "#/definitions/notify"
52454 Represents a slice or partial piece of a resource that gets separately allotted
52455 ###### Related Nodes
52456 - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
52457 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
52458 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52459 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
52460 - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
52461 - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
52462 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
52463 - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
52464 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52465 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
52466 - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
52467 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
52468 - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
52469 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
52475 description: Allotted Resource id UUID assigned to this instance.
52478 description: The descriptive information assigned to this allotted resource instance
52481 description: Link back to more information in the controller
52482 model-invariant-id:
52484 description: the ASDC model id for this resource or service model.
52487 description: the ASDC model version for this resource or service model.
52488 persona-model-version:
52490 description: the ASDC model version for this resource or service model.
52493 description: Concurrency value
52494 orchestration-status:
52496 description: Orchestration status
52497 operational-status:
52499 description: Indicator for whether the resource is considered operational
52502 description: Generic description of the type of allotted resource.
52505 description: role in the network that this resource will be providing.
52509 $ref: "#/definitions/tunnel-xconnect"
52513 $ref: "#/definitions/relationship"
52514 allotted-resources:
52516 This object is used to store slices of services being offered
52521 $ref: "#/definitions/allotted-resource"
52524 Availability zone, a collection of compute hosts/pservers
52525 ###### Related Nodes
52526 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52527 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52528 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52529 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52530 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52531 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52532 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
52533 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52534 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52536 - availability-zone-name
52539 availability-zone-name:
52541 description: Name of the availability zone. Unique across a cloud region
52544 description: Type of hypervisor. Source of truth should define valid values.
52545 operational-status:
52547 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
52550 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52554 $ref: "#/definitions/relationship"
52555 availability-zones:
52557 Collection of availability zones
52562 $ref: "#/definitions/availability-zone"
52563 az-and-dvs-switches:
52567 $ref: "#/definitions/dvs-switches"
52570 $ref: "#/definitions/availability-zone"
52573 Namespace for business related constructs
52578 $ref: "#/definitions/connector"
52582 $ref: "#/definitions/customer"
52586 $ref: "#/definitions/line-of-business"
52590 $ref: "#/definitions/owning-entity"
52594 $ref: "#/definitions/platform"
52598 $ref: "#/definitions/project"
52601 ###### Related Nodes
52602 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
52608 description: unique identifier of probe
52611 description: identifier of probe
52614 description: type of probe
52617 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52621 $ref: "#/definitions/relationship"
52622 classes-of-service:
52624 class-of-service of probe
52629 $ref: "#/definitions/class-of-service"
52630 cloud-infrastructure:
52632 Namespace for cloud infrastructure.
52637 $ref: "#/definitions/complex"
52641 $ref: "#/definitions/cloud-region"
52645 $ref: "#/definitions/network-profile"
52649 $ref: "#/definitions/pserver"
52650 virtual-data-centers:
52653 $ref: "#/definitions/virtual-data-center"
52656 cloud-region designates an installation of a cloud cluster or region or instantiation.
52657 ###### Related Nodes
52658 - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
52659 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52660 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52661 - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52662 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52663 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52664 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52665 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52666 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52667 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52668 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52669 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52670 - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52671 - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52672 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52673 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
52674 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
52675 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
52676 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
52677 - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
52685 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
52688 description: Identifier used by the vendor for the region. Second part of composite key
52691 description: Type of the cloud (e.g., openstack)
52692 owner-defined-type:
52694 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
52695 cloud-region-version:
52697 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
52700 description: URL of the keystone identity service
52703 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52706 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52711 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
52714 description: MultiVIM will discover and expose EPA capabilities.
52717 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52721 $ref: "#/definitions/volume-group"
52725 $ref: "#/definitions/tenant"
52729 $ref: "#/definitions/flavor"
52733 $ref: "#/definitions/group-assignment"
52737 $ref: "#/definitions/snapshot"
52741 $ref: "#/definitions/image"
52745 $ref: "#/definitions/dvs-switch"
52749 $ref: "#/definitions/oam-network"
52750 availability-zones:
52753 $ref: "#/definitions/availability-zone"
52757 $ref: "#/definitions/relationship"
52758 esr-system-info-list:
52761 $ref: "#/definitions/esr-system-info"
52762 vip-ipv4-address-list:
52765 $ref: "#/definitions/vip-ipv4-address-list"
52766 vip-ipv6-address-list:
52769 $ref: "#/definitions/vip-ipv6-address-list"
52775 $ref: "#/definitions/cloud-region"
52778 Collection of physical locations that can house cloud-regions.
52779 ###### Related Nodes
52780 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52781 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52782 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52783 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
52784 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
52785 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
52786 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52787 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52788 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
52789 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52790 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52791 - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52792 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
52793 - COMPLEX is DELETED when these are DELETED CTAG-POOL
52795 - physical-location-id
52796 - physical-location-type
52803 physical-location-id:
52805 description: Unique identifier for physical location, e.g., CLLI
52808 description: Data center code which can be an alternate way to identify a complex
52811 description: Gamma complex name for LCP instance.
52814 description: URL of the keystone identity service
52817 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52818 physical-location-type:
52820 description: Type, e.g., central office, data center.
52846 $ref: "#/definitions/ctag-pool"
52850 $ref: "#/definitions/relationship"
52853 Collection of physical locations that can house cloud-regions.
52858 $ref: "#/definitions/complex"
52861 Port Mirror Configuration.
52862 ###### Related Nodes
52863 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
52864 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
52865 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
52866 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
52867 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
52868 - CONFIGURATION is DELETED when these are DELETED METADATUM
52869 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
52872 - configuration-type
52873 - configuration-sub-type
52874 - orchestration-status
52875 - operational-status
52876 - configuration-selflink
52877 - model-customization-id
52881 description: UUID assigned to configuration.
52884 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
52885 configuration-name:
52887 description: Name of the configuration.
52888 configuration-type:
52890 description: port-mirroring-configuration.
52891 configuration-sub-type:
52893 description: vprobe, pprobe.
52894 model-invariant-id:
52896 description: the ASDC model id for this resource or service model.
52899 description: the ASDC model version for this resource or service model.
52900 orchestration-status:
52902 description: Orchestration status of the configuration.
52903 operational-status:
52905 description: Indicator for whether the resource is considered operational.
52906 configuration-selflink:
52908 description: URL to endpoint where AAI can get more details from SDN-GC.
52909 model-customization-id:
52911 description: id of the configuration used to customize the resource
52914 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52918 $ref: "#/definitions/relationship"
52922 $ref: "#/definitions/metadatum"
52925 Collection of configurations
52930 $ref: "#/definitions/configuration"
52933 Collection of resource instances used to connect a variety of disparate inventory widgets
52934 ###### Related Nodes
52935 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52936 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
52937 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
52938 - CONNECTOR is DELETED when these are DELETED METADATUM
52940 - resource-instance-id
52942 resource-instance-id:
52944 description: Unique id of resource instance.
52947 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52948 model-invariant-id:
52950 description: the ASDC model id for this resource or service model.
52953 description: the ASDC model version for this resource or service model.
52954 persona-model-version:
52956 description: the ASDC model version for this resource or service model.
52959 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52960 widget-model-version:
52962 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52966 $ref: "#/definitions/relationship"
52970 $ref: "#/definitions/metadatum"
52973 Collection of resource instances used to connect a variety of disparate inventory widgets
52978 $ref: "#/definitions/connector"
52979 constrained-element-set:
52981 This is how we would capture constraints defining allowed sets of elements.
52982 ###### Related Nodes
52983 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
52984 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
52985 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
52986 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
52988 - constrained-element-set-uuid
52992 constrained-element-set-uuid:
53000 element-choice-sets:
53003 $ref: "#/definitions/element-choice-set"
53007 $ref: "#/definitions/relationship"
53008 constrained-element-sets:
53010 constrained-element-set:
53013 $ref: "#/definitions/constrained-element-set"
53016 ###### Related Nodes
53017 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
53018 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
53028 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53032 $ref: "#/definitions/relationship"
53038 $ref: "#/definitions/ctag-assignment"
53041 A collection of C tags (vlan tags) grouped for a specific purpose.
53042 ###### Related Nodes
53043 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53044 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53045 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53046 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53049 - availability-zone-name
53050 - ctag-pool-purpose
53054 description: The Target provider edge router
53055 availability-zone-name:
53057 description: Name of the availability zone
53060 description: Describes what the intended purpose of this pool is.
53063 description: Comma separated list of ctags
53066 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53070 $ref: "#/definitions/relationship"
53076 $ref: "#/definitions/ctag-pool"
53079 customer identifiers to provide linkage back to BSS information.
53080 ###### Related Nodes
53081 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
53082 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
53084 - global-customer-id
53088 global-customer-id:
53090 description: Global customer id used across ECOMP to uniquely identify customer.
53093 description: Subscriber name, an alternate way to retrieve a customer.
53096 description: Subscriber type, a way to provide VID with only the INFRA customers.
53099 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53100 service-subscriptions:
53103 $ref: "#/definitions/service-subscription"
53107 $ref: "#/definitions/relationship"
53110 Collection of customer identifiers to provide linkage back to BSS information.
53115 $ref: "#/definitions/customer"
53123 description: See mis-na-virtualization-platform.yang
53126 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53130 $ref: "#/definitions/relationship"
53136 $ref: "#/definitions/cvlan-tag-entry"
53139 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.
53140 ###### Related Nodes
53141 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53142 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53149 description: DVS switch name
53152 description: URL used to reach the vcenter
53155 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53159 $ref: "#/definitions/relationship"
53162 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53167 $ref: "#/definitions/dvs-switch"
53170 Internal map to define the properties of an edge and interpret the map EdgeRules
53186 edge-tag-query-request:
53197 $ref: "#/definitions/start-node-filter"
53198 include-node-filter:
53201 $ref: "#/definitions/include-node-filter"
53205 $ref: "#/definitions/secondary-filter"
53206 edge-tag-query-result:
53208 tagged-inventory-item-list:
53211 $ref: "#/definitions/tagged-inventory-item-list"
53212 element-choice-set:
53214 This is how we would capture constraints defining allowed sets of elements.
53215 ###### Related Nodes
53216 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53217 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
53218 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
53220 - element-choice-set-uuid
53221 - element-choice-set-name
53223 element-choice-set-uuid:
53225 element-choice-set-name:
53234 $ref: "#/definitions/model-element"
53238 $ref: "#/definitions/relationship"
53239 element-choice-sets:
53241 element-choice-set:
53244 $ref: "#/definitions/element-choice-set"
53247 Metadata for entitlement group.
53248 ###### Related Nodes
53249 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53250 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
53257 description: Unique ID for the entitlement group the resource comes from, should be uuid.
53260 description: Unique ID of an entitlement resource.
53263 description: Concurrency value
53267 $ref: "#/definitions/relationship"
53270 Entitlements, keyed by group-uuid and resource-uuid, related to license management
53275 $ref: "#/definitions/entitlement"
53278 Persist EMS address information used by EMS driver.
53279 ###### Related Nodes
53280 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
53281 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53287 description: Unique ID of EMS.
53290 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53291 esr-system-info-list:
53293 $ref: "#/definitions/esr-system-info-list"
53296 $ref: "#/definitions/relationship-list"
53302 $ref: "#/definitions/esr-ems"
53305 Persist common address information of external systems.
53306 ###### Related Nodes
53307 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
53308 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
53309 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
53310 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
53312 - esr-system-info-id
53317 esr-system-info-id:
53319 description: Unique ID of esr system info.
53322 description: name of external system.
53325 description: type of external systems.
53328 description: vendor of external systems.
53331 description: version of external systems.
53334 description: url used to access external systems.
53337 description: username used to access external systems.
53340 description: password used to access external systems.
53343 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53346 description: protocol of third party SDNC, for example netconf/snmp.
53349 description: ca file content if enabled ssl on auth-url.
53352 description: Whether to verify VIM's certificate.
53355 description: service IP of ftp server.
53358 description: service port of ftp server.
53361 description: domain info for authentication.
53364 description: default tenant of VIM.
53367 description: ftp passive mode or not.
53370 description: resource or performance data file path.
53373 description: the status of external system.
53376 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53380 $ref: "#/definitions/relationship"
53381 esr-system-info-list:
53383 Collection of persistent block-level external system auth info.
53388 $ref: "#/definitions/esr-system-info"
53389 esr-thirdparty-sdnc:
53391 Persist SDNC address information used by ONAP SDNC.
53392 ###### Related Nodes
53393 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
53394 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
53395 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53397 - thirdparty-sdnc-id
53399 thirdparty-sdnc-id:
53401 description: Unique ID of SDNC.
53404 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53407 description: password used to access SDNC server.
53410 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53411 esr-system-info-list:
53413 $ref: "#/definitions/esr-system-info-list"
53416 $ref: "#/definitions/relationship-list"
53417 esr-thirdparty-sdnc-list:
53419 esr-thirdparty-sdnc:
53422 $ref: "#/definitions/esr-thirdparty-sdnc"
53425 Persist VNFM address information used by VF-C.
53426 ###### Related Nodes
53427 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
53428 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53434 description: Unique ID of VNFM.
53437 description: indecate the VIM to deploy VNF.
53440 description: certificate url of VNFM.
53443 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53444 esr-system-info-list:
53446 $ref: "#/definitions/esr-system-info-list"
53449 $ref: "#/definitions/relationship-list"
53455 $ref: "#/definitions/esr-vnfm"
53458 evc object is an optional child object of the Configuration object.
53459 ###### Related Nodes
53460 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53466 description: Unique/key field for the evc object
53467 forwarding-path-topology:
53469 description: Point-to-Point, Multi-Point
53472 description: Commited Information Rate
53475 description: CIR units
53476 connection-diversity-group-id:
53478 description: Diversity Group ID
53481 description: formerly Performance Group
53482 esp-evc-circuit-id:
53484 description: EVC Circuit ID of ESP EVC
53487 description: Committed Information Rate (For ESP)
53490 description: CIR units (For ESP)
53493 description: Identifies ESP
53494 collector-pop-clli:
53496 description: Collector POP CLLI (from the hostname of the access pnf)
53497 inter-connect-type-ingress:
53499 description: Interconnect type on ingress side of EVC.
53500 tagmode-access-ingress:
53502 description: tagode for collector side of EVC
53503 tagmode-access-egress:
53505 description: tagMode for network side of EVC
53509 $ref: "#/definitions/relationship"
53512 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53518 $ref: "#/definitions/evc"
53521 Namespace for external system.
53525 $ref: "#/definitions/esr-ems-list"
53528 $ref: "#/definitions/esr-vnfm-list"
53529 esr-thirdparty-sdnc-list:
53531 $ref: "#/definitions/esr-thirdparty-sdnc-list"
53534 Extra properties for inventory item for response list
53539 $ref: "#/definitions/extra-property"
53549 ###### Related Nodes
53550 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53551 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
53552 - FLAVOR cannot be deleted if linked to VSERVER
53560 description: Flavor id, expected to be unique across cloud-region.
53563 description: Flavor name
53567 description: Number of CPUs
53571 description: Amount of memory
53575 description: Disk space
53579 description: Amount of ephemeral disk space
53582 description: amount of swap space allocation
53585 description: whether flavor is available to all users or private to the tenant it was created in.
53588 description: URL to endpoint where AAI can get more details
53591 description: Boolean as to whether this flavor is no longer enabled
53594 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53598 $ref: "#/definitions/relationship"
53601 Collection of openstack flavors.
53606 $ref: "#/definitions/flavor"
53609 Entity describing a sequenced segment of forwarding path
53610 ###### Related Nodes
53611 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53612 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
53613 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53614 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
53615 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
53616 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
53623 description: Unique ID of this segmentation
53626 description: ingress, intermediate, egress
53630 $ref: "#/definitions/relationship"
53633 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53636 forwarder object is an optional child object of the Configuration object.
53637 ###### Related Nodes
53638 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53644 description: Key for forwarder-evc object
53647 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53650 description: Internal VLAN.
53653 description: SVLAN value for ingress of egress forwarder.
53656 description: CVLAN value for ingress of egress forwarder.
53660 $ref: "#/definitions/relationship"
53663 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53669 $ref: "#/definitions/forwarder-evc"
53675 $ref: "#/definitions/forwarder"
53678 Entity that describes the sequenced forwarding path between interfaces of services or resources
53679 ###### Related Nodes
53680 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
53681 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53682 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53683 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
53684 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
53686 - forwarding-path-id
53687 - forwarding-path-name
53689 forwarding-path-id:
53691 description: Unique ID of this FP
53692 forwarding-path-name:
53694 description: Name of the FP
53698 $ref: "#/definitions/relationship"
53701 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53704 description: the self link for this FP
53708 $ref: "#/definitions/forwarder"
53714 $ref: "#/definitions/forwarding-path"
53717 General purpose VNF
53718 ###### Related Nodes
53719 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53720 - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
53721 - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
53722 - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53723 - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53724 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
53725 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53726 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
53727 - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
53728 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
53729 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
53730 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53731 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
53732 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53733 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
53734 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53735 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53736 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53737 - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53738 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53739 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53740 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
53741 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53742 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53743 - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
53744 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
53745 - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
53746 - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
53747 - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
53754 - vnf-discriptor-name
53757 - is-closed-loop-disabled
53761 description: Unique id of VNF. This is unique across the graph.
53764 description: vnf instance id.
53767 description: Name of VNF.
53770 description: Alternate name of VNF.
53773 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.
53776 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
53777 regional-resource-zone:
53779 description: Regional way of organizing pservers, source of truth should define values
53782 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53783 operational-status:
53785 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
53788 description: OBSOLETE - do not use
53791 description: Client should send valid enumerated value
53792 orchestration-status:
53794 description: Orchestration status of this VNF, used by MSO.
53797 vnf-discriptor-name:
53799 description: vnf discriptor name
53802 description: job id corresponding to vnf
53805 description: Heat stack id corresponding to this instance, managed by MSO
53808 description: Corresponds to the SDN-C catalog id used to configure this VCE
53811 description: identifier of managed by ATT or customer
53814 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53815 ipv4-loopback0-address:
53817 description: v4 Loopback0 address
53820 description: v6 Loopback address
53821 management-v6-address:
53823 description: v6 management address
53827 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53830 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
53834 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53837 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
53841 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
53844 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
53848 description: number of associated SHD in vnf.
53852 description: number of vms in vnf.
53856 description: number of network in vnf.
53859 is-closed-loop-disabled:
53863 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53866 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
53867 encrypted-access-flag:
53869 description: indicates whether generic-vnf access uses SSH
53870 entitlement-assignment-group-uuid:
53872 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
53873 entitlement-resource-uuid:
53875 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
53876 license-assignment-group-uuid:
53878 description: UUID of the license assignment group. OBSOLETE - See child relationships.
53881 description: UUID of the actual license resource. OBSOLETE - See child relationships.
53882 model-invariant-id:
53884 description: the ASDC model id for this resource or service model.
53887 description: the ASDC model version for this resource or service model.
53888 persona-model-version:
53890 description: the ASDC model version for this resource or service model.
53891 model-customization-id:
53893 description: captures the id of all the configuration used to customize the resource for the service.
53896 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53897 widget-model-version:
53899 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53902 description: as-number of the VNF
53903 regional-resource-subzone:
53905 description: represents sub zone of the rr plane
53908 description: Generic description of the type of NF
53911 description: English description of Network function that the specific VNF deployment is providing
53914 description: role in the network that this model will be providing
53917 description: string assigned to this model used for naming purposes
53920 description: Path to the controller object.
53921 ipv4-oam-gateway-address:
53923 description: Gateway address
53924 ipv4-oam-gateway-address-prefix-length:
53927 description: Prefix length for oam-address
53931 description: Temporary location for S-TAG to get to VCE
53934 description: Network Management profile of this VNF
53938 $ref: "#/definitions/relationship"
53942 $ref: "#/definitions/l-interface"
53946 $ref: "#/definitions/lag-interface"
53950 $ref: "#/definitions/vf-module"
53954 $ref: "#/definitions/license"
53958 $ref: "#/definitions/entitlement"
53966 $ref: "#/definitions/generic-vnf"
53969 Openstack group-assignment used to store exclusivity groups (EG).
53970 ###### Related Nodes
53971 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53972 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
53973 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
53981 description: Group id, expected to be unique across cloud-region.
53984 description: Group type - the type of group this instance refers to
53987 description: Group name - name assigned to the group
53990 description: Group description - description of the group
53993 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53997 $ref: "#/definitions/relationship"
54000 Collection of openstack group assignments
54005 $ref: "#/definitions/group-assignment"
54008 ###### Related Nodes
54009 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
54017 description: host-route id
54020 description: subnet prefix
54023 description: Could be ip-address, hostname, or service-instance
54026 description: Should be ip-address, hostname, or service-instance to match next-hop
54029 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54033 $ref: "#/definitions/relationship"
54039 $ref: "#/definitions/host-route"
54042 Collection of HPA Capabilities
54047 $ref: "#/definitions/hpa-capability"
54050 Represents a HPA capability
54051 ###### Related Nodes
54052 - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
54053 - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54054 - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
54055 - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
54057 - hpa-capability-id
54062 description: UUID to uniquely identify a HPA capability
54065 description: Name of the HPACapability
54068 description: HPA schema version
54071 description: Hardware architecture
54074 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54078 $ref: "#/definitions/relationship"
54079 hpa-feature-attributes:
54082 $ref: "#/definitions/hpa-feature-attributes"
54083 hpa-feature-attributes:
54085 HPA Capability Feature attributes
54086 ###### Related Nodes
54087 - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
54089 - hpa-attribute-key
54093 description: name of the specific HPA attribute
54094 hpa-attribute-value:
54096 description: JSON string specifying the value, unit and type of the specific HPA attribute
54099 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54103 $ref: "#/definitions/relationship"
54107 ###### Related Nodes
54108 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54109 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54110 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
54111 - IMAGE cannot be deleted if linked to VSERVER
54112 - IMAGE is DELETED when these are DELETED METADATUM
54122 description: Image id, expected to be unique across cloud region
54125 description: Image name
54126 image-architecture:
54128 description: Operating system architecture.
54131 description: The common name of the operating system distribution in lowercase
54134 description: The operating system version as specified by the distributor.
54137 description: The application that the image instantiates.
54138 application-vendor:
54140 description: The vendor of the application.
54141 application-version:
54143 description: The version of the application.
54146 description: URL to endpoint where AAI can get more details
54149 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54153 $ref: "#/definitions/relationship"
54157 $ref: "#/definitions/metadatum"
54160 Collectio of Openstack images.
54165 $ref: "#/definitions/image"
54166 include-node-filter:
54172 InstanceFilter for performing a named-query or model query
54175 InstanceFilters for performing a named-query or model query
54180 $ref: "#/definitions/instance-filter"
54183 General mechanism for grouping instances
54184 ###### Related Nodes
54185 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54186 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54187 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54188 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54189 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54190 - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54191 - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54192 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54193 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54194 - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54195 - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54196 - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54198 - instance-group-role
54199 - model-invariant-id
54205 instance-group-role:
54207 description: role of the instance group.
54208 model-invariant-id:
54210 description: ASDC model id for this resource or service model.
54213 description: ASDC model version uid for this resource model.
54216 description: Instance Group ID, UUID assigned to this instance.
54219 description: Descriptive text to help identify the usage of this instance-group
54222 description: Only valid value today is lower case ha for high availability
54225 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
54228 description: Concurrency value
54232 $ref: "#/definitions/relationship"
54235 Collection of openstack route table references
54240 $ref: "#/definitions/instance-group"
54245 $ref: "#/definitions/search"
54248 $ref: "#/definitions/actions"
54249 cloud-infrastructure:
54251 $ref: "#/definitions/cloud-infrastructure"
54254 $ref: "#/definitions/external-system"
54257 $ref: "#/definitions/business"
54258 service-design-and-creation:
54260 $ref: "#/definitions/service-design-and-creation"
54263 $ref: "#/definitions/network"
54266 $ref: "#/definitions/aai-internal"
54270 $ref: "#/definitions/aai-internal"
54273 inventory-item-type:
54275 inventory-item-link:
54277 inventory-item-data:
54280 $ref: "#/definitions/inventory-item-data"
54281 tagged-inventory-item-list:
54284 $ref: "#/definitions/tagged-inventory-item-list"
54285 inventory-item-data:
54291 inventory-response-item:
54293 Inventory item for response list
54299 $ref: "#/definitions/extra-properties"
54300 inventory-response-items:
54302 $ref: "#/definitions/inventory-response-items"
54303 inventory-response-items:
54305 Container for inventory items in response list
54307 inventory-response-item:
54310 $ref: "#/definitions/inventory-response-item"
54311 ipsec-configuration:
54313 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
54314 ###### Related Nodes
54315 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
54316 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
54317 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
54319 - ipsec-configuration-id
54321 ipsec-configuration-id:
54323 description: UUID of this configuration
54324 requested-vig-address-type:
54326 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54327 requested-encryption-strength:
54329 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54330 requested-dmz-type:
54332 description: ATT can offer a shared DMZ or a DMZ specific to a customer
54333 shared-dmz-network-address:
54335 description: Network address of shared DMZ
54336 requested-customer-name:
54338 description: If the DMZ is a custom DMZ, this field will indicate the customer information
54341 description: can be 1 or 2
54342 ikev1-authentication:
54344 description: Contains values like md5, sha1, sha256, sha384
54347 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54350 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54353 description: Group name defined in VIG for clients using aggressive mode
54356 description: pre-shared key for the above group name
54359 description: Lifetime for IKEv1 SA
54360 ipsec-authentication:
54362 description: md5, sha1, sha256, sha384
54365 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54368 description: Life time for IPSec SA
54371 description: enable PFS or not
54374 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
54375 xauth-user-password:
54377 description: Encrypted using the Juniper $9$ algorithm
54380 description: The time between DPD probe
54383 description: Maximum number of DPD before claiming the tunnel is down
54386 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54390 $ref: "#/definitions/relationship"
54394 $ref: "#/definitions/vig-server"
54395 ipsec-configurations:
54397 ipsec-configuration:
54400 $ref: "#/definitions/ipsec-configuration"
54409 Logical interfaces, e.g., a vnic.
54410 ###### Related Nodes
54411 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54412 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54413 - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54414 - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54415 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54416 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
54417 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
54418 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
54419 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
54420 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54421 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54422 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
54423 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
54424 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54425 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
54426 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
54435 description: Name given to the interface
54438 description: E.g., CUSTOMER, UPLINK, etc.
54441 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54444 description: URL to endpoint where AAI can get more details
54447 description: ID of interface
54450 description: MAC address for the interface
54453 description: Name of the network
54456 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54457 interface-description:
54459 description: Human friendly text regarding this interface.
54464 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54469 description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
54472 allowed-address-pairs:
54474 description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
54478 $ref: "#/definitions/vlan"
54482 $ref: "#/definitions/sriov-vf"
54486 $ref: "#/definitions/l-interface"
54490 $ref: "#/definitions/relationship"
54491 l3-interface-ipv4-address-list:
54494 $ref: "#/definitions/l3-interface-ipv4-address-list"
54495 l3-interface-ipv6-address-list:
54498 $ref: "#/definitions/l3-interface-ipv6-address-list"
54501 Collection of logical interfaces.
54506 $ref: "#/definitions/l-interface"
54507 l3-interface-ipv4-address-list:
54510 ###### Related Nodes
54511 - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54512 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54513 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54514 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54515 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54516 - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
54518 - l3-interface-ipv4-address
54520 l3-interface-ipv4-address:
54522 description: IP address
54523 l3-interface-ipv4-prefix-length:
54526 description: Prefix length, 32 for single address
54530 description: Inner VLAN tag
54534 description: Outer VLAN tag
54537 description: Indicator of fixed or floating address
54540 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54541 neutron-network-id:
54543 description: Neutron network id of the interface that address belongs to
54546 description: Neutron id of subnet that address belongs to
54550 $ref: "#/definitions/relationship"
54551 l3-interface-ipv6-address-list:
54554 ###### Related Nodes
54555 - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54556 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54557 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54558 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54559 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54560 - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
54562 - l3-interface-ipv6-address
54564 l3-interface-ipv6-address:
54566 description: IP address
54567 l3-interface-ipv6-prefix-length:
54570 description: Prefix length, 128 for single address
54574 description: Inner VLAN tag
54578 description: Outer VLAN tag
54581 description: Indicator of fixed or floating address
54584 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54585 neutron-network-id:
54587 description: Neutron network id of the interface that address belongs to
54590 description: Neutron id of subnet that address belongs to
54594 $ref: "#/definitions/relationship"
54597 Generic network definition
54598 ###### Related Nodes
54599 - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54600 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
54601 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
54602 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54603 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
54604 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54605 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54606 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54607 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54608 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54609 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54610 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54611 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
54612 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54613 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54614 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
54615 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
54620 - is-provider-network
54621 - is-shared-network
54622 - is-external-network
54626 description: Network ID, should be uuid. Unique across A&AI.
54629 description: Name of the network, governed by some naming convention..
54632 description: Type of the network - who defines these values?
54635 description: Role the network plans - who defines these values?
54636 network-technology:
54638 description: Network technology - who defines these values?
54639 neutron-network-id:
54641 description: Neutron network id of this Interface
54646 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
54647 network-role-instance:
54650 description: network role instance
54653 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54654 orchestration-status:
54656 description: Orchestration status of this VNF, mastered by MSO
54659 description: Heat stack id corresponding to this instance, managed by MSO
54662 description: Corresponds to the SDN-C catalog id used to configure this VCE
54663 contrail-network-fqdn:
54665 description: Contrail FQDN for the network
54666 model-invariant-id:
54668 description: the ASDC model id for this resource or service model.
54671 description: the ASDC model version for this resource or service model.
54672 persona-model-version:
54674 description: the ASDC model version for this resource or service model.
54675 model-customization-id:
54677 description: captures the id of all the configuration used to customize the resource for the service.
54680 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54681 widget-model-version:
54683 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54684 physical-network-name:
54686 description: Name associated with the physical network.
54687 is-provider-network:
54691 is-external-network:
54695 description: Path to the controller object.
54696 operational-status:
54698 description: Indicator for whether the resource is considered operational.
54702 $ref: "#/definitions/subnet"
54706 $ref: "#/definitions/ctag-assignment"
54707 segmentation-assignments:
54710 $ref: "#/definitions/segmentation-assignment"
54714 $ref: "#/definitions/relationship"
54715 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
54721 $ref: "#/definitions/l3-network"
54724 Link aggregate interface
54725 ###### Related Nodes
54726 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54727 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54728 - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54729 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
54730 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
54731 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
54732 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
54733 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54734 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
54735 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
54742 description: Name that identifies the link aggregate interface
54743 interface-description:
54745 description: Human friendly text regarding this interface.
54748 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54751 description: Captures the numeric part of the speed
54754 description: Captures the units corresponding to the speed
54757 description: ID of interface
54760 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
54763 description: Trigger for operational monitoring of this resource by Service Assurance systems.
54769 $ref: "#/definitions/relationship"
54773 $ref: "#/definitions/l-interface"
54776 Collection of link aggregate interfaces.
54781 $ref: "#/definitions/lag-interface"
54784 LAG links can connect lag-interfaces
54785 ###### Related Nodes
54786 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54787 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54793 description: Alphabetical concatenation of lag-interface names
54796 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54800 $ref: "#/definitions/relationship"
54803 Collection of link aggregation connections
54808 $ref: "#/definitions/lag-link"
54811 Metadata for license group.
54812 ###### Related Nodes
54813 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54814 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
54821 description: Unique ID for the license group the resource belongs to, should be uuid.
54824 description: Unique ID of a license resource.
54827 description: Concurrency value
54831 $ref: "#/definitions/relationship"
54834 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54839 $ref: "#/definitions/license"
54842 describes a line-of-business
54843 ###### Related Nodes
54844 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
54846 - line-of-business-name
54848 line-of-business-name:
54850 description: Name of the line-of-business (product)
54853 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54857 $ref: "#/definitions/relationship"
54860 Collection of lines-of-business
54865 $ref: "#/definitions/line-of-business"
54868 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54869 ###### Related Nodes
54870 - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
54871 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
54872 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54873 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54874 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
54875 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
54876 - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54877 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54878 - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54879 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54880 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54881 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
54882 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54883 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54884 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54892 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54897 description: Type of logical link, e.g., evc
54900 description: Captures the numeric part of the speed
54903 description: Captures the units corresponding to the speed
54906 description: v4, v6, or ds for dual stack
54909 description: For example, static or BGP
54912 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54913 model-invariant-id:
54915 description: the ASDC model id for this resource or service model.
54918 description: the ASDC model version for this resource or service model.
54919 persona-model-version:
54921 description: the ASDC model version for this resource or service model.
54924 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54925 widget-model-version:
54927 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54928 operational-status:
54930 description: Indication of operational status of the logical link.
54933 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
54936 description: Indication of the network use of the logical link.
54939 description: Alias or alternate name (CLCI or D1 name).
54942 description: UUID of the logical-link, SDNC generates this.
54945 description: Circuit id
54948 description: Reason for this entity, role it is playing
54952 $ref: "#/definitions/relationship"
54955 Collection of logical connections
54960 $ref: "#/definitions/logical-link"
54963 Collection of metadatum (key/value pairs)
54968 $ref: "#/definitions/metadatum"
54972 ###### Related Nodes
54973 - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
54974 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
54975 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54976 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
54977 - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54988 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54991 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
54992 ###### Related Nodes
54993 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54994 - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54995 - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54996 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
54997 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
54998 - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
54999 - MODEL is DELETED when these are DELETED MODEL-VER
55001 - model-invariant-id
55004 model-invariant-id:
55006 description: Unique identifier corresponding to the main definition of a model in ASDC
55009 description: Type of the model, e.g., service, resource, widget, etc.
55012 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55016 $ref: "#/definitions/model-ver"
55020 $ref: "#/definitions/relationship"
55021 model-and-named-query-search:
55023 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
55027 $ref: "#/definitions/query-parameters"
55030 $ref: "#/definitions/instance-filters"
55033 $ref: "#/definitions/secondary-filts"
55036 secondary-filter-cut-point:
55040 This is how we would capture constraints defining allowed sets of elements.
55041 ###### Related Nodes
55042 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55043 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
55044 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
55046 - model-constraint-uuid
55047 - constrained-element-set-uuid-to-replace
55049 model-constraint-uuid:
55051 constrained-element-set-uuid-to-replace:
55053 constrained-element-sets:
55056 $ref: "#/definitions/constrained-element-set"
55059 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55065 $ref: "#/definitions/model-constraint"
55068 Defines how other models combine to make up a higher-level model.
55069 ###### Related Nodes
55070 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
55071 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55072 - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55073 - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55074 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55075 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55076 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55077 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
55079 - model-element-uuid
55080 - new-data-del-flag
55083 model-element-uuid:
55087 description: Indicates whether this element was created as part of instantiation from this model
55090 description: How many of this type of element are required/allowed
55095 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55099 $ref: "#/definitions/model-element"
55100 description: Defines how other models combine to make up a higher-level model
55104 $ref: "#/definitions/model-constraint"
55105 description: Describes new constraints on this model element that are not part of that model's definition
55109 $ref: "#/definitions/relationship"
55115 $ref: "#/definitions/model-element"
55118 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
55119 ###### Related Nodes
55120 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55121 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55122 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55123 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55124 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
55125 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
55133 description: Unique identifier corresponding to one version of a model in ASDC
55136 description: Name of the model, which can change from version to version.
55139 description: Version
55142 description: Description
55145 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55149 $ref: "#/definitions/model-element"
55153 $ref: "#/definitions/metadatum"
55157 $ref: "#/definitions/relationship"
55163 $ref: "#/definitions/model-ver"
55166 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
55171 $ref: "#/definitions/model"
55172 multicast-configuration:
55174 ###### Related Nodes
55175 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
55177 - multicast-configuration-id
55178 - multicast-protocol
55181 multicast-configuration-id:
55183 description: Unique id of multicast configuration.
55184 multicast-protocol:
55186 description: protocol of multicast configuration
55189 description: rp type of multicast configuration
55192 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55196 $ref: "#/definitions/relationship"
55197 multicast-configurations:
55199 multicast configuration of generic-vnf ip-address
55201 multicast-configuration:
55204 $ref: "#/definitions/multicast-configuration"
55210 $ref: "#/definitions/named-query"
55214 ###### Related Nodes
55215 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55216 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
55217 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55218 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
55222 - named-query-version
55228 named-query-version:
55230 required-input-param:
55236 named-query-elements:
55239 $ref: "#/definitions/named-query-element"
55243 $ref: "#/definitions/relationship"
55244 named-query-element:
55247 ###### Related Nodes
55248 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55249 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
55250 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55251 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55252 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55253 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55254 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
55256 - named-query-element-uuid
55258 named-query-element-uuid:
55260 property-collect-list:
55264 property-limit-desc:
55268 named-query-elements:
55271 $ref: "#/definitions/named-query-element"
55275 $ref: "#/definitions/related-lookup"
55276 property-constraints:
55279 $ref: "#/definitions/property-constraint"
55283 $ref: "#/definitions/relationship"
55284 named-query-elements:
55286 named-query-element:
55289 $ref: "#/definitions/named-query-element"
55292 Namespace for network inventory resources.
55297 $ref: "#/definitions/logical-link"
55301 $ref: "#/definitions/site-pair-set"
55305 $ref: "#/definitions/vpn-binding"
55309 $ref: "#/definitions/vpls-pe"
55310 multicast-configurations:
55313 $ref: "#/definitions/multicast-configuration"
55317 $ref: "#/definitions/vce"
55321 $ref: "#/definitions/vnfc"
55325 $ref: "#/definitions/l3-network"
55329 $ref: "#/definitions/network-policy"
55333 $ref: "#/definitions/generic-vnf"
55337 $ref: "#/definitions/lag-link"
55341 $ref: "#/definitions/newvce"
55345 $ref: "#/definitions/pnf"
55349 $ref: "#/definitions/physical-link"
55350 ipsec-configurations:
55353 $ref: "#/definitions/ipsec-configuration"
55354 route-table-references:
55357 $ref: "#/definitions/route-table-reference"
55361 $ref: "#/definitions/instance-group"
55365 $ref: "#/definitions/zone"
55369 $ref: "#/definitions/configurations"
55375 $ref: "#/definitions/network-policy"
55378 ###### Related Nodes
55379 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
55380 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
55382 - network-policy-id
55386 description: UUID representing unique key to this instance
55387 network-policy-fqdn:
55389 description: Contrail FQDN for the policy
55392 description: ID for the openStack Heat instance
55395 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55399 $ref: "#/definitions/relationship"
55402 Network profile populated by SDN-GP for SNMP
55403 ###### Related Nodes
55404 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55410 description: Unique name of network profile.
55413 description: Encrypted SNMP community string
55416 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55420 $ref: "#/definitions/relationship"
55423 Collection of network profiles
55428 $ref: "#/definitions/network-profile"
55431 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
55432 ###### Related Nodes
55433 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
55434 - NEWVCE is DELETED when these are DELETED L-INTERFACE
55442 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
55445 description: Name of VNF.
55448 description: Alternate name of VNF.
55451 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.
55454 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55455 operational-status:
55457 description: Indicator for whether the resource is considered operational
55460 description: OBSOLETE - do not use
55463 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
55466 description: Client should send valid enumerated value.
55469 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55470 ipv4-loopback0-address:
55472 description: v4 Loopback0 address
55473 orchestration-status:
55475 description: Orchestration status of this VNF, mastered by MSO.
55478 description: Heat stack id corresponding to this instance, managed by MSO
55481 description: Corresponds to the SDN-C catalog id used to configure this VCE
55485 $ref: "#/definitions/relationship"
55489 $ref: "#/definitions/l-interface"
55492 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
55497 $ref: "#/definitions/newvce"
55498 notification-event:
55502 notification-event-header:
55504 $ref: "#/definitions/notification-event-header"
55505 notification-event-header:
55546 $ref: "#/definitions/key-data"
55551 OAM network, to be deprecated shortly. Do not use for new purposes.
55552 ###### Related Nodes
55553 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55554 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
55555 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55563 description: UUID of the network. Unique across a cloud-region
55566 description: Name of the network.
55570 description: cvlan-id
55571 ipv4-oam-gateway-address:
55573 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55574 ipv4-oam-gateway-address-prefix-length:
55577 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55580 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55584 $ref: "#/definitions/relationship"
55587 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
55592 $ref: "#/definitions/oam-network"
55593 operational-environment:
55595 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55596 ###### Related Nodes
55597 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55598 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55600 - operational-environment-id
55601 - operational-environment-name
55602 - operational-environment-type
55603 - operational-environment-status
55607 operational-environment-id:
55609 description: UUID of an operational environment
55610 operational-environment-name:
55612 description: Operational Environment name
55613 operational-environment-type:
55615 description: Operational Environment Type.
55616 operational-environment-status:
55618 description: Status
55621 description: Tenant Context.
55624 description: Workload Context.
55627 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55631 $ref: "#/definitions/relationship"
55632 operational-environments:
55634 a logical partition of the cloud which allows to have multiple environments in the production AIC.
55636 operational-environment:
55639 $ref: "#/definitions/operational-environment"
55642 Allows for legacy POST of old-style and new-style models
55644 - model-invariant-id
55645 - model-name-version-id
55651 model-invariant-id:
55653 description: Unique identifier corresponding to the main definition of a model in ASDC
55654 model-name-version-id:
55656 description: Unique identifier corresponding to one version of a model in ASDC
55659 description: Type of the model, e.g., service, resource, widget, etc.
55662 description: Name of the model, which can change from version to version.
55665 description: Invariant unique ID which does not change from version to version
55668 description: Version
55671 description: Description
55674 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55677 $ref: "#/definitions/model-vers"
55680 $ref: "#/definitions/relationship-list"
55683 Collection of owning-entities
55688 $ref: "#/definitions/owning-entity"
55691 describes an owning-entity
55692 ###### Related Nodes
55693 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
55696 - owning-entity-name
55700 description: UUID of an owning entity
55701 owning-entity-name:
55703 description: Owning entity name
55706 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55710 $ref: "#/definitions/relationship"
55713 Physical interface (e.g., nic)
55714 ###### Related Nodes
55715 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
55716 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55717 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55718 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55719 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
55720 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
55721 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
55722 - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
55723 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
55724 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
55731 description: Name that identifies the physical interface
55734 description: Captures the numeric part of the speed
55737 description: Captures the units corresponding to the speed
55740 description: Nature of the services and connectivity on this port.
55741 equipment-identifier:
55743 description: CLEI or other specification for p-interface hardware.
55746 description: Role specification for p-interface hardware.
55749 description: Indicates the physical properties of the interface.
55752 description: Trigger for operational monitoring of this resource by Service Assurance systems.
55755 description: MAC Address of the p-interface.
55758 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55763 description: inventory status
55767 $ref: "#/definitions/relationship"
55771 $ref: "#/definitions/sriov-pf"
55775 $ref: "#/definitions/l-interface"
55778 Collection of physical interfaces.
55783 $ref: "#/definitions/p-interface"
55786 Collection of physical connections, typically between p-interfaces
55787 ###### Related Nodes
55788 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55794 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55797 description: Captures the numeric part of the speed
55800 description: Captures the units corresponding to the speed
55803 description: Circuit it
55806 description: Dual access mode (e.g., primary, secondary
55809 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55810 service-provider-name:
55812 description: Name of the service Provider on this link.
55813 service-provider-bandwidth-up-value:
55816 description: Upstream Bandwidth value agreed with the service provider
55817 service-provider-bandwidth-up-units:
55819 description: Units for the upstream BW value
55820 service-provider-bandwidth-down-value:
55823 description: Downstream Bandwidth value agreed with the service provider
55824 service-provider-bandwidth-down-units:
55826 description: Units for downstream BW value
55829 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55833 $ref: "#/definitions/relationship"
55836 Collection of physical connections, typically between p-interfaces
55841 $ref: "#/definitions/physical-link"
55844 describes a platform
55845 ###### Related Nodes
55846 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55852 description: Name of the platform
55855 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55859 $ref: "#/definitions/relationship"
55862 Collection of platforms
55867 $ref: "#/definitions/platform"
55870 PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
55871 ###### Related Nodes
55872 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55873 - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55874 - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
55875 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
55876 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
55877 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
55878 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55879 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55880 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
55881 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55888 description: unique name of Physical Network Function.
55891 description: name of Physical Network Function.
55894 description: source of name2
55897 description: id of pnf
55900 description: Equipment type. Source of truth should define valid values.
55903 description: Equipment vendor. Source of truth should define valid values.
55906 description: Equipment model. Source of truth should define valid values.
55909 description: identifier of managed by ATT or customer
55912 description: ipv4-oam-address with new naming convention for IP addresses
55915 description: sw-version is the version of SW for the hosted application on the PNF.
55920 description: ID of the physical frame (relay rack) where pnf is installed.
55923 description: Serial number of the device
55924 ipaddress-v4-loopback-0:
55926 description: IPV4 Loopback 0 address
55927 ipaddress-v6-loopback-0:
55929 description: IPV6 Loopback 0 address
55932 description: IPV4 AIM address
55935 description: IPV6 AIM address
55938 description: IPV6 OAM address
55941 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
55944 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55947 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
55950 description: Nf Role is the role performed by this instance in the network.
55954 $ref: "#/definitions/relationship"
55958 $ref: "#/definitions/p-interface"
55962 $ref: "#/definitions/lag-interface"
55965 Collection of Physical Network Functions.
55970 $ref: "#/definitions/pnf"
55973 Used to capture the network interfaces of this VCE
55974 ###### Related Nodes
55975 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55976 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
55977 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
55980 - orchestration-status
55984 description: Unique ID of the interface
55985 neutron-network-id:
55987 description: Neutron network id of this Interface
55988 neutron-network-name:
55990 description: Neutron network name of this Interface
55993 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55996 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55999 description: Unique ID for port group in vmware
56002 description: Likely to duplicate value of neutron network name
56005 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
56006 orchestration-status:
56008 description: Orchestration status of this VNF, mastered by MSO
56011 description: Heat stack id corresponding to this instance, managed by MSO
56014 description: Corresponds to the SDN-C catalog id used to configure this VCE
56018 $ref: "#/definitions/cvlan-tag-entry"
56022 $ref: "#/definitions/relationship"
56028 $ref: "#/definitions/port-group"
56031 describes the project
56032 ###### Related Nodes
56033 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
56039 description: Name of the project deploying a service
56042 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56046 $ref: "#/definitions/relationship"
56049 Collection of projects
56054 $ref: "#/definitions/project"
56057 Property holder for query properties or instance properties
56063 property-constraint:
56066 ###### Related Nodes
56067 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56069 - property-constraint-uuid
56074 property-constraint-uuid:
56084 property-constraints:
56086 property-constraint:
56089 $ref: "#/definitions/property-constraint"
56092 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
56093 ###### Related Nodes
56094 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
56095 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
56096 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
56097 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56098 - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56099 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
56100 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
56101 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56102 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56103 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
56104 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
56105 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56106 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
56113 description: Value from executing hostname on the compute node.
56116 description: PTNII name
56120 description: Number of cpus
56124 description: Disk size, in GBs
56128 description: RAM size, in MBs
56131 description: Equipment type. Source of truth should define valid values.
56134 description: Equipment vendor. Source of truth should define valid values.
56137 description: Equipment model. Source of truth should define valid values.
56140 description: Fully-qualified domain name
56143 description: URL to endpoint where AAI can get more details
56146 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
56149 description: Serial number, may be queried
56150 ipaddress-v4-loopback-0:
56152 description: IPV4 Loopback 0 address
56153 ipaddress-v6-loopback-0:
56155 description: IPV6 Loopback 0 address
56158 description: IPV4 AIM address
56161 description: IPV6 AIM address
56164 description: IPV6 OAM address
56167 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
56170 description: ID of Pserver
56173 description: internet topology of Pserver
56178 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56181 description: alternative pserver name
56184 description: purpose of pserver
56187 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
56190 description: Indicates who owns and or manages the device.
56193 description: The host profile that defines the configuration of the pserver.
56197 $ref: "#/definitions/relationship"
56201 $ref: "#/definitions/p-interface"
56205 $ref: "#/definitions/lag-interface"
56208 Collection of compute hosts.
56213 $ref: "#/definitions/pserver"
56216 QueryParameters for performing a named-query or model query
56220 $ref: "#/definitions/named-query"
56223 $ref: "#/definitions/overloaded-model"
56227 ###### Related Nodes
56228 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56230 - related-lookup-uuid
56232 - source-node-property
56234 - target-node-property
56236 related-lookup-uuid:
56240 source-node-property:
56244 target-node-property:
56246 property-collect-list:
56253 $ref: "#/definitions/relationship"
56259 $ref: "#/definitions/related-lookup"
56260 related-to-property:
56264 description: Key part of a key/value pair
56267 description: Value part of a key/value pair
56272 description: A keyword provided by A&AI to indicate type of node.
56275 description: URL to the object in A&AI.
56279 $ref: "#/definitions/relationship-data"
56283 - relationship-value
56287 description: A keyword provided by A&AI to indicate an attribute.
56288 relationship-value:
56290 description: Value of the attribute.
56296 $ref: "#/definitions/relationship"
56297 reserved-prop-names:
56299 Internal map to define some reserved properties of a vertex
56301 last-mod-source-of-truth:
56319 Response container for the results of a named-query or model query
56321 inventory-response-items:
56323 $ref: "#/definitions/inventory-response-items"
56328 description: The specific type of node in the A&AI graph
56331 description: The URL to the specific resource
56332 route-table-reference:
56334 Openstack route table reference.
56335 ###### Related Nodes
56336 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
56338 - route-table-reference-id
56339 - route-table-reference-fqdn
56341 route-table-reference-id:
56343 description: Route Table Reference id, UUID assigned to this instance.
56344 route-table-reference-fqdn:
56346 description: FQDN entry in the route table.
56349 description: Concurrency value
56353 $ref: "#/definitions/relationship"
56354 route-table-references:
56356 Collection of openstack route table references
56358 route-table-reference:
56361 $ref: "#/definitions/route-table-reference"
56364 Route target information
56365 ###### Related Nodes
56366 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
56368 - global-route-target
56369 - route-target-role
56371 global-route-target:
56373 description: Number used to identify an RT, globally unique in the network
56376 description: Role assigned to this route target
56379 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56383 $ref: "#/definitions/relationship"
56386 Collection of route target information
56391 $ref: "#/definitions/route-target"
56394 ###### Related Nodes
56395 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56396 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56397 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
56399 - routing-instance-id
56401 routing-instance-id:
56403 description: Unique id of routing instance
56406 description: rpm owner
56409 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56413 $ref: "#/definitions/site-pair"
56417 $ref: "#/definitions/relationship"
56420 set of probes related to generic-vnf routing instance
56425 $ref: "#/definitions/routing-instance"
56430 $ref: "#/definitions/oam-networks"
56431 az-and-dvs-switches:
56434 $ref: "#/definitions/az-and-dvs-switches"
56437 edge-tag-query-result:
56439 $ref: "#/definitions/edge-tag-query-result"
56440 edge-tag-query-request:
56442 $ref: "#/definitions/edge-tag-query-request"
56445 $ref: "#/definitions/search-results"
56448 $ref: "#/definitions/sdn-zone-response"
56454 $ref: "#/definitions/result-data"
56457 SecondaryFilt for performing a named-query or model query
56468 SecondaryFilts for performing a named-query or model query
56473 $ref: "#/definitions/secondary-filt"
56474 segmentation-assignment:
56476 Openstack segmentation assignment.
56477 ###### Related Nodes
56478 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56484 description: Route Table Reference id, UUID assigned to this instance.
56487 description: Concurrency value
56491 $ref: "#/definitions/relationship"
56492 segmentation-assignments:
56494 Collection of openstack segmentation assignments
56496 segmentation-assignment:
56499 $ref: "#/definitions/segmentation-assignment"
56502 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
56505 - service-description
56509 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56510 service-description:
56512 description: Description of the service
56515 description: URL to endpoint where AAI can get more details
56518 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56521 description: service version
56525 $ref: "#/definitions/relationship"
56526 service-capabilities:
56528 Collection of service capabilities.
56530 service-capability:
56533 $ref: "#/definitions/service-capability"
56534 service-capability:
56536 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
56537 ###### Related Nodes
56538 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56539 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56540 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
56547 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56550 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.
56553 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56557 $ref: "#/definitions/relationship"
56558 service-design-and-creation:
56560 Namespace for objects managed by ASDC
56565 $ref: "#/definitions/vnf-image"
56569 $ref: "#/definitions/service"
56570 service-capabilities:
56573 $ref: "#/definitions/service-capability"
56577 $ref: "#/definitions/model"
56581 $ref: "#/definitions/named-query"
56584 Instance of a service
56585 ###### Related Nodes
56586 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
56587 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
56588 - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
56589 - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
56590 - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
56591 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
56592 - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
56593 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
56594 - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56595 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
56596 - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
56597 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56598 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
56599 - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56600 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56601 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56602 - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
56603 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56604 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56605 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56606 - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
56607 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56609 - service-instance-id
56616 service-instance-id:
56618 description: Uniquely identifies this instance of a service
56619 service-instance-name:
56621 description: This field will store a name assigned to the service-instance.
56624 description: String capturing type of service.
56627 description: String capturing the service role.
56628 environment-context:
56630 description: This field will store the environment context assigned to the service-instance.
56633 description: This field will store the workload context assigned to the service-instance.
56636 description: create time of Network Service.
56639 description: last update of Network Service.
56642 description: short description for service-instance.
56643 model-invariant-id:
56645 description: the ASDC model id for this resource or service model.
56648 description: the ASDC model version for this resource or service model.
56649 persona-model-version:
56651 description: the ASDC model version for this resource or service model.
56654 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56655 widget-model-version:
56657 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56660 description: Indicates the total bandwidth to be used for this service.
56663 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
56664 bandwidth-down-wan1:
56666 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
56669 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
56670 bandwidth-down-wan2:
56672 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
56675 description: URL customers will use to access the vHN Portal.
56676 service-instance-location-id:
56678 description: An identifier that customers assign to the location where this service is being used.
56681 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56684 description: Path to the controller object.
56685 orchestration-status:
56687 description: Orchestration status of this service.
56691 $ref: "#/definitions/relationship"
56695 $ref: "#/definitions/metadatum"
56696 allotted-resources:
56699 $ref: "#/definitions/allotted-resource"
56702 Collection of service instances
56707 $ref: "#/definitions/service-instance"
56708 service-subscription:
56710 Object that group service instances.
56711 ###### Related Nodes
56712 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
56713 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56714 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56715 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
56721 description: Value defined by orchestration to identify this service across ECOMP.
56722 temp-ub-sub-account-id:
56724 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
56727 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56731 $ref: "#/definitions/service-instance"
56735 $ref: "#/definitions/relationship"
56736 service-subscriptions:
56738 Collection of objects that group service instances.
56740 service-subscription:
56743 $ref: "#/definitions/service-subscription"
56746 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
56751 $ref: "#/definitions/service"
56754 ###### Related Nodes
56755 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56756 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
56757 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
56763 description: unique identifier of probe
56766 description: Prefix address
56769 description: Prefix address
56772 description: ip version, v4, v6
56773 destination-hostname:
56775 description: Hostname of the destination equipment to which SLAs are measured against.
56776 destination-equip-type:
56778 description: The type of destinatination equipment. Could be Router, UCPE, etc.
56781 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56782 classes-of-service:
56785 $ref: "#/definitions/class-of-service"
56789 $ref: "#/definitions/relationship"
56792 Set of instances for probes used to measure service level agreements
56793 ###### Related Nodes
56794 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
56795 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56796 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
56802 description: Unique id of site pair set.
56805 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56809 $ref: "#/definitions/routing-instance"
56813 $ref: "#/definitions/relationship"
56816 Collection of sets of instances for probes related to generic-vnf
56821 $ref: "#/definitions/site-pair-set"
56829 $ref: "#/definitions/site-pair"
56833 ###### Related Nodes
56834 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56835 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
56841 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56844 description: Snapshot name
56845 snapshot-architecture:
56847 description: Operating system architecture
56848 snapshot-os-distro:
56850 description: The common name of the operating system distribution in lowercase
56851 snapshot-os-version:
56853 description: The operating system version as specified by the distributor.
56856 description: The application that the image instantiates.
56857 application-vendor:
56859 description: The vendor of the application.
56860 application-version:
56862 description: The version of the application.
56865 description: URL to endpoint where AAI can get more details
56868 description: This field contains the UUID of the previous snapshot (if any).
56871 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56875 $ref: "#/definitions/relationship"
56878 Collection of openstack snapshots
56883 $ref: "#/definitions/snapshot"
56886 SR-IOV Physical Function
56887 ###### Related Nodes
56888 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
56889 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
56895 description: Identifier for the sriov-pf
56898 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56902 $ref: "#/definitions/relationship"
56905 Collection of SR-IOV Physical Functions.
56910 $ref: "#/definitions/sriov-pf"
56913 SR-IOV Virtual Function (not to be confused with virtual network function)
56914 ###### Related Nodes
56915 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
56916 - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
56922 description: PCI ID used to identify the sriov-vf
56925 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56928 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56931 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56932 vf-vlan-anti-spoof-check:
56934 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.
56935 vf-mac-anti-spoof-check:
56937 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.
56940 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56941 vf-broadcast-allow:
56943 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56944 vf-unknown-multicast-allow:
56946 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56947 vf-unknown-unicast-allow:
56949 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56952 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56955 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
56958 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56959 neutron-network-id:
56961 description: Neutron network id of the interface
56965 $ref: "#/definitions/relationship"
56968 Collection of SR-IOV Virtual Functions.
56973 $ref: "#/definitions/sriov-vf"
56982 ###### Related Nodes
56983 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56984 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56985 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56986 - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
56987 - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56988 - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56989 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
56990 - SUBNET is DELETED when these are DELETED HOST-ROUTE
56997 description: Subnet ID, should be UUID.
57000 description: Name associated with the subnet.
57003 description: Neutron id of this subnet
57006 description: gateway ip address
57007 network-start-address:
57009 description: network start address
57012 description: cidr mask
57015 description: ip version
57016 orchestration-status:
57018 description: Orchestration status of this VNF, mastered by MSO
57023 description: the start address reserved for use by dhcp
57026 description: the last address reserved for use by dhcp
57029 description: role of the subnet, referenced when assigning IPs
57030 ip-assignment-direction:
57032 description: ip address assignment direction of the subnet
57035 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57039 description: sequence of the subnet
57043 $ref: "#/definitions/host-route"
57047 $ref: "#/definitions/relationship"
57053 $ref: "#/definitions/subnet"
57054 tagged-inventory-item-list:
57059 $ref: "#/definitions/inventory-item"
57063 ###### Related Nodes
57064 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57065 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
57066 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57067 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57068 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
57069 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57070 - TENANT cannot be deleted if linked to VSERVER
57077 description: Unique id relative to the cloud-region.
57080 description: Readable name of tenant
57083 description: This field will store the tenant context.
57086 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57090 $ref: "#/definitions/vserver"
57094 $ref: "#/definitions/relationship"
57097 Collection of openstack tenants.
57102 $ref: "#/definitions/tenant"
57105 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
57106 ###### Related Nodes
57107 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
57110 - bandwidth-up-wan1
57111 - bandwidth-down-wan1
57112 - bandwidth-up-wan2
57113 - bandwidth-down-wan2
57117 description: Allotted Resource id UUID assigned to this instance.
57120 description: The WAN uplink bandwidth for WAN1
57121 bandwidth-down-wan1:
57123 description: The WAN downlink bandwidth for WAN1
57126 description: The WAN uplink bandwidth for WAN2
57127 bandwidth-down-wan2:
57129 description: The WAN downlink bandwidth for WAN2
57132 description: Concurrency value
57136 $ref: "#/definitions/relationship"
57139 This object is used to store the specific tunnel cross connect aspects of an allotted resource
57144 $ref: "#/definitions/tunnel-xconnect"
57147 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
57156 $ref: "#/definitions/update-node-key"
57162 $ref: "#/definitions/action"
57171 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
57172 ###### Related Nodes
57173 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
57174 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
57175 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57176 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57177 - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57178 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57179 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
57180 - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
57188 description: Unique id of VNF. This is unique across the graph.
57191 description: Name of VNF.
57194 description: Alternate name of VNF.
57197 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.
57200 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
57201 regional-resource-zone:
57203 description: Regional way of organizing pservers, source of truth should define values
57206 description: Trigger for operational monitoring of this resource by Service Assurance systems.
57207 operational-status:
57209 description: Indicator for whether the resource is considered operational
57212 description: OBSOLETE - do not use
57215 description: Network role being played by this VNF
57216 orchestration-status:
57218 description: Orchestration status of this VNF, mastered by MSO
57221 description: Heat stack id corresponding to this instance, managed by MSO
57224 description: Corresponds to the SDN-C catalog id used to configure this VCE
57227 description: Unique ID of VPE connected to this VCE.
57228 v6-vce-wan-address:
57230 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
57233 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
57236 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57237 ipv4-loopback0-address:
57239 description: Loopback0 address
57240 entitlement-resource-uuid:
57242 description: OBSOLETE - see child relationships
57246 $ref: "#/definitions/port-group"
57250 $ref: "#/definitions/license"
57254 $ref: "#/definitions/entitlement"
57258 $ref: "#/definitions/relationship"
57261 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
57266 $ref: "#/definitions/vce"
57269 a deployment unit of VNFCs
57270 ###### Related Nodes
57271 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57272 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
57273 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57274 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57275 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57276 - VF-MODULE cannot be deleted if linked to VNFC
57279 - is-base-vf-module
57283 description: Unique ID of vf-module.
57286 description: Name of vf-module
57289 description: Heat stack id corresponding to this instance.
57290 orchestration-status:
57292 description: orchestration status of this vf-module, mastered by MSO
57297 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57298 model-invariant-id:
57300 description: the ASDC model id for this resource or service model.
57303 description: the ASDC model version for this resource or service model.
57304 persona-model-version:
57306 description: the ASDC model version for this resource or service model.
57307 model-customization-id:
57309 description: captures the id of all the configuration used to customize the resource for the service.
57312 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57313 widget-model-version:
57315 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57316 contrail-service-instance-fqdn:
57318 description: the Contrail unique ID for a service-instance
57322 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
57325 description: Path to the controller object.
57329 $ref: "#/definitions/relationship"
57332 Collection of vf-modules, a deployment unit of VNFCs
57337 $ref: "#/definitions/vf-module"
57340 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
57341 ###### Related Nodes
57342 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
57348 description: indicates whether the VIG is for AVPN or INTERNET
57351 description: v4 IP of the vig server
57354 description: v6 IP of the vig server
57357 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57361 $ref: "#/definitions/relationship"
57367 $ref: "#/definitions/vig-server"
57368 vip-ipv4-address-list:
57371 ###### Related Nodes
57372 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57373 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57374 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57375 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
57381 description: IP address
57382 vip-ipv4-prefix-length:
57385 description: Prefix length, 32 for single address
57389 description: Inner VLAN tag
57393 description: Outer VLAN tag
57396 description: Indicator of fixed or floating address
57399 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57400 neutron-network-id:
57402 description: Neutron network id of the interface that address belongs to
57405 description: Neutron id of subnet that address belongs to
57409 $ref: "#/definitions/relationship"
57410 vip-ipv6-address-list:
57413 ###### Related Nodes
57414 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57415 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57416 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57417 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
57423 description: IP address
57424 vip-ipv6-prefix-length:
57427 description: Prefix length, 128 for single address
57431 description: Inner VLAN tag
57435 description: Outer VLAN tag
57438 description: Indicator of fixed or floating address
57441 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57442 neutron-network-id:
57444 description: Neutron network id of the interface that address belongs to
57447 description: Neutron id of subnet that address belongs to
57451 $ref: "#/definitions/relationship"
57452 virtual-data-center:
57454 Virtual organization of cloud infrastructure elements in a data center context
57455 ###### Related Nodes
57456 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57457 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57458 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57465 description: Unique ID of the vdc
57468 description: Name of the virtual data center
57471 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57475 $ref: "#/definitions/relationship"
57476 virtual-data-centers:
57478 Virtual organization of cloud infrastructure elements in a data center context
57480 virtual-data-center:
57483 $ref: "#/definitions/virtual-data-center"
57487 ###### Related Nodes
57488 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
57489 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57490 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
57491 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
57492 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
57493 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57494 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57495 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
57496 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
57504 description: String that identifies the interface
57508 description: Inner VLAN tag
57512 description: Outer VLAN tag
57515 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57518 description: Captures the numeric part of the speed
57521 description: Captures the units corresponding to the speed
57524 description: Used to describe (the service associated with) the vlan
57525 backdoor-connection:
57527 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
57530 description: This indicates the customers VPN ID associated with this vlan
57531 orchestration-status:
57533 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
57538 description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
57544 $ref: "#/definitions/relationship"
57545 l3-interface-ipv4-address-list:
57548 $ref: "#/definitions/l3-interface-ipv4-address-list"
57549 l3-interface-ipv6-address-list:
57552 $ref: "#/definitions/l3-interface-ipv6-address-list"
57558 $ref: "#/definitions/vlan"
57567 description: Unique id of VNF. This is unique across the graph.
57570 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
57571 ###### Related Nodes
57572 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
57573 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
57577 - application-vendor
57581 description: Unique ID of this asset
57584 description: The application that the image instantiates.
57585 application-vendor:
57587 description: The vendor of the application.
57588 application-version:
57590 description: The version of the application.
57593 description: URL to endpoint where AAI can get more details
57596 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57600 $ref: "#/definitions/relationship"
57603 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
57608 $ref: "#/definitions/vnf-image"
57611 ###### Related Nodes
57612 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57613 - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57614 - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
57615 - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
57616 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57617 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57618 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
57619 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
57620 - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
57626 - is-closed-loop-disabled
57630 description: Unique ID of vnfc.
57633 description: Short code that is used in naming instances of the item being modeled
57636 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
57639 description: prov status of this vnfc
57640 orchestration-status:
57642 description: Orchestration status of this VNF, mastered by APP-C
57643 ipaddress-v4-oam-vip:
57645 description: Oam V4 vip address of this vnfc
57648 is-closed-loop-disabled:
57652 description: Group notation of VNFC
57653 model-invariant-id:
57655 description: the ASDC model id for this resource or service model.
57658 description: the ASDC model version for this resource or service model.
57661 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57665 $ref: "#/definitions/relationship"
57666 l3-interface-ipv4-address-list:
57669 $ref: "#/definitions/l3-interface-ipv4-address-list"
57670 l3-interface-ipv6-address-list:
57673 $ref: "#/definitions/l3-interface-ipv6-address-list"
57676 virtual network components associated with a vserver from application controller.
57681 $ref: "#/definitions/vnfc"
57684 Ephemeral Block storage volume.
57685 ###### Related Nodes
57686 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
57693 description: Unique ID of block storage volume relative to the vserver.
57696 description: URL to endpoint where AAI can get more details
57699 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57703 $ref: "#/definitions/relationship"
57706 Persistent block-level storage.
57707 ###### Related Nodes
57708 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57709 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57710 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57711 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57712 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57715 - volume-group-name
57720 description: Unique ID of volume-group.
57723 description: Name of the volume group.
57726 description: Heat stack id corresponding to this volume-group
57729 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.
57730 orchestration-status:
57732 description: Orchestration status of this volume-group
57733 model-customization-id:
57735 description: captures the id of all the configuration used to customize the resource for the service.
57736 vf-module-model-customization-id:
57738 description: helps relate the volume group to the vf-module whose components will require the volume group
57741 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57745 $ref: "#/definitions/relationship"
57748 Collection of persistent block-level storage.
57753 $ref: "#/definitions/volume-group"
57756 Collection of ephemeral Block storage volumes.
57761 $ref: "#/definitions/volume"
57764 VPLS Provider Edge routers.
57765 ###### Related Nodes
57766 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57767 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
57768 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57769 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57770 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
57778 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57781 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
57784 description: Client should send valid enumerated value, e.g., VPLS-PE.
57788 description: Temporary location for stag to get to VCE
57791 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57795 $ref: "#/definitions/relationship"
57799 $ref: "#/definitions/p-interface"
57803 $ref: "#/definitions/lag-interface"
57806 Collection of VPLS Provider Edge routers
57811 $ref: "#/definitions/vpls-pe"
57815 ###### Related Nodes
57816 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
57817 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57818 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57819 - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
57820 - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
57821 - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
57828 description: VPN ID, globally unique within A&AI
57831 description: VPN Name
57834 description: the platform associated with the VPN example AVPN, Mobility
57837 description: Type of the vpn, should be taken from enumerated/valid values
57840 description: region of customer vpn
57843 description: id for this customer vpn
57844 route-distinguisher:
57846 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
57849 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57853 $ref: "#/definitions/route-target"
57857 $ref: "#/definitions/relationship"
57858 description: l3-networks relate to vpn-bindings
57864 $ref: "#/definitions/vpn-binding"
57867 Virtual Servers, aka virtual machine or VM.
57868 ###### Related Nodes
57869 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57870 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
57871 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
57872 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
57873 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
57874 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
57875 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
57876 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57877 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
57878 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57879 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57880 - VSERVER is DELETED when these are DELETED L-INTERFACE
57881 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
57887 - is-closed-loop-disabled
57891 description: Unique identifier for this vserver relative to its tenant
57894 description: Name of vserver
57897 description: Alternative name of vserver
57900 description: Trigger for operational monitoring of this resource by Service Assurance systems.
57903 description: URL to endpoint where AAI can get more details
57906 is-closed-loop-disabled:
57910 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57914 $ref: "#/definitions/volume"
57918 $ref: "#/definitions/relationship"
57922 $ref: "#/definitions/l-interface"
57925 Collection of virtual Servers, aka virtual machines or VMs.
57930 $ref: "#/definitions/vserver"
57933 A zone is a grouping of assets in a location homing to the same connections into the CBB
57934 ###### Related Nodes
57935 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57936 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57937 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57938 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57939 - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57948 description: Code assigned by AIC to the zone
57951 description: English name associated with the zone
57954 description: Design of zone [Medium/Large?]
57957 description: Context of zone [production/test]
57960 description: Status of a zone.
57963 description: Concurrency value
57967 $ref: "#/definitions/relationship"
57970 Collection of zones
57975 $ref: "#/definitions/zone"
57990 $ref: "#/patchDefinitions/action-data"
57999 APIs that are more action related than REST (e.g., notify, update).
58003 $ref: "#/patchDefinitions/update"
58006 $ref: "#/patchDefinitions/notify"
58009 Represents a slice or partial piece of a resource that gets separately allotted
58010 ###### Related Nodes
58011 - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
58012 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
58013 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58014 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
58015 - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
58016 - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
58017 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
58018 - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
58019 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
58020 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
58021 - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
58022 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
58023 - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
58024 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
58030 description: Allotted Resource id UUID assigned to this instance.
58033 description: The descriptive information assigned to this allotted resource instance
58036 description: Link back to more information in the controller
58037 model-invariant-id:
58039 description: the ASDC model id for this resource or service model.
58042 description: the ASDC model version for this resource or service model.
58043 persona-model-version:
58045 description: the ASDC model version for this resource or service model.
58046 allotted-resources:
58048 This object is used to store slices of services being offered
58053 $ref: "#/patchDefinitions/allotted-resource"
58056 Availability zone, a collection of compute hosts/pservers
58057 ###### Related Nodes
58058 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58059 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
58060 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58061 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58062 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58063 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58064 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
58065 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58066 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
58068 - availability-zone-name
58071 availability-zone-name:
58073 description: Name of the availability zone. Unique across a cloud region
58076 description: Type of hypervisor. Source of truth should define valid values.
58077 operational-status:
58079 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
58080 availability-zones:
58082 Collection of availability zones
58087 $ref: "#/patchDefinitions/availability-zone"
58088 az-and-dvs-switches:
58092 $ref: "#/patchDefinitions/dvs-switches"
58095 $ref: "#/patchDefinitions/availability-zone"
58098 Namespace for business related constructs
58103 $ref: "#/patchDefinitions/connector"
58107 $ref: "#/patchDefinitions/customer"
58111 $ref: "#/patchDefinitions/line-of-business"
58115 $ref: "#/patchDefinitions/owning-entity"
58119 $ref: "#/patchDefinitions/platform"
58123 $ref: "#/patchDefinitions/project"
58126 ###### Related Nodes
58127 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
58133 description: unique identifier of probe
58136 description: identifier of probe
58139 description: type of probe
58140 classes-of-service:
58142 class-of-service of probe
58147 $ref: "#/patchDefinitions/class-of-service"
58148 cloud-infrastructure:
58150 Namespace for cloud infrastructure.
58155 $ref: "#/patchDefinitions/complex"
58159 $ref: "#/patchDefinitions/cloud-region"
58163 $ref: "#/patchDefinitions/network-profile"
58167 $ref: "#/patchDefinitions/pserver"
58168 virtual-data-centers:
58171 $ref: "#/patchDefinitions/virtual-data-center"
58174 cloud-region designates an installation of a cloud cluster or region or instantiation.
58175 ###### Related Nodes
58176 - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
58177 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58178 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58179 - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58180 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58181 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58182 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58183 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58184 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58185 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58186 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58187 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58188 - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58189 - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58190 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58191 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
58192 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
58193 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
58194 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
58195 - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58203 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
58206 description: Identifier used by the vendor for the region. Second part of composite key
58209 description: Type of the cloud (e.g., openstack)
58210 owner-defined-type:
58212 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
58213 cloud-region-version:
58215 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
58218 description: URL of the keystone identity service
58221 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
58224 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
58229 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
58232 description: MultiVIM will discover and expose EPA capabilities.
58238 $ref: "#/patchDefinitions/cloud-region"
58241 Collection of physical locations that can house cloud-regions.
58242 ###### Related Nodes
58243 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58244 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58245 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58246 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
58247 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
58248 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
58249 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58250 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58251 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
58252 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58253 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58254 - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58255 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
58256 - COMPLEX is DELETED when these are DELETED CTAG-POOL
58258 - physical-location-id
58259 - physical-location-type
58266 physical-location-id:
58268 description: Unique identifier for physical location, e.g., CLLI
58271 description: Data center code which can be an alternate way to identify a complex
58274 description: Gamma complex name for LCP instance.
58277 description: URL of the keystone identity service
58280 Collection of physical locations that can house cloud-regions.
58285 $ref: "#/patchDefinitions/complex"
58288 Port Mirror Configuration.
58289 ###### Related Nodes
58290 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
58291 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
58292 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
58293 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58294 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58295 - CONFIGURATION is DELETED when these are DELETED METADATUM
58296 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
58299 - configuration-type
58300 - configuration-sub-type
58301 - orchestration-status
58302 - operational-status
58303 - configuration-selflink
58304 - model-customization-id
58308 description: UUID assigned to configuration.
58311 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
58312 configuration-name:
58314 description: Name of the configuration.
58315 configuration-type:
58317 description: port-mirroring-configuration.
58318 configuration-sub-type:
58320 description: vprobe, pprobe.
58321 model-invariant-id:
58323 description: the ASDC model id for this resource or service model.
58326 description: the ASDC model version for this resource or service model.
58327 orchestration-status:
58329 description: Orchestration status of the configuration.
58330 operational-status:
58332 description: Indicator for whether the resource is considered operational.
58333 configuration-selflink:
58335 description: URL to endpoint where AAI can get more details from SDN-GC.
58336 model-customization-id:
58338 description: id of the configuration used to customize the resource
58341 Collection of configurations
58346 $ref: "#/patchDefinitions/configuration"
58349 Collection of resource instances used to connect a variety of disparate inventory widgets
58350 ###### Related Nodes
58351 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58352 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
58353 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
58354 - CONNECTOR is DELETED when these are DELETED METADATUM
58356 - resource-instance-id
58358 resource-instance-id:
58360 description: Unique id of resource instance.
58363 Collection of resource instances used to connect a variety of disparate inventory widgets
58368 $ref: "#/patchDefinitions/connector"
58369 constrained-element-set:
58371 This is how we would capture constraints defining allowed sets of elements.
58372 ###### Related Nodes
58373 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
58374 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
58375 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
58376 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
58378 - constrained-element-set-uuid
58382 constrained-element-set-uuid:
58388 constrained-element-sets:
58390 constrained-element-set:
58393 $ref: "#/patchDefinitions/constrained-element-set"
58396 ###### Related Nodes
58397 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58398 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
58411 $ref: "#/patchDefinitions/ctag-assignment"
58414 A collection of C tags (vlan tags) grouped for a specific purpose.
58415 ###### Related Nodes
58416 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
58417 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58418 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
58419 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
58422 - availability-zone-name
58423 - ctag-pool-purpose
58427 description: The Target provider edge router
58428 availability-zone-name:
58430 description: Name of the availability zone
58433 description: Describes what the intended purpose of this pool is.
58436 description: Comma separated list of ctags
58442 $ref: "#/patchDefinitions/ctag-pool"
58445 customer identifiers to provide linkage back to BSS information.
58446 ###### Related Nodes
58447 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
58448 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
58450 - global-customer-id
58454 global-customer-id:
58456 description: Global customer id used across ECOMP to uniquely identify customer.
58459 description: Subscriber name, an alternate way to retrieve a customer.
58462 description: Subscriber type, a way to provide VID with only the INFRA customers.
58465 Collection of customer identifiers to provide linkage back to BSS information.
58470 $ref: "#/patchDefinitions/customer"
58478 description: See mis-na-virtualization-platform.yang
58484 $ref: "#/patchDefinitions/cvlan-tag-entry"
58487 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.
58488 ###### Related Nodes
58489 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58490 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58497 description: DVS switch name
58500 description: URL used to reach the vcenter
58503 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
58508 $ref: "#/patchDefinitions/dvs-switch"
58511 Internal map to define the properties of an edge and interpret the map EdgeRules
58527 edge-tag-query-request:
58538 $ref: "#/patchDefinitions/start-node-filter"
58539 include-node-filter:
58542 $ref: "#/patchDefinitions/include-node-filter"
58546 $ref: "#/patchDefinitions/secondary-filter"
58547 edge-tag-query-result:
58549 tagged-inventory-item-list:
58552 $ref: "#/patchDefinitions/tagged-inventory-item-list"
58553 element-choice-set:
58555 This is how we would capture constraints defining allowed sets of elements.
58556 ###### Related Nodes
58557 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
58558 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
58559 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
58561 - element-choice-set-uuid
58562 - element-choice-set-name
58564 element-choice-set-uuid:
58566 element-choice-set-name:
58570 element-choice-sets:
58572 element-choice-set:
58575 $ref: "#/patchDefinitions/element-choice-set"
58578 Metadata for entitlement group.
58579 ###### Related Nodes
58580 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58581 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
58588 description: Unique ID for the entitlement group the resource comes from, should be uuid.
58591 description: Unique ID of an entitlement resource.
58594 Entitlements, keyed by group-uuid and resource-uuid, related to license management
58599 $ref: "#/patchDefinitions/entitlement"
58602 Persist EMS address information used by EMS driver.
58603 ###### Related Nodes
58604 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
58605 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58611 description: Unique ID of EMS.
58617 $ref: "#/patchDefinitions/esr-ems"
58620 Persist common address information of external systems.
58621 ###### Related Nodes
58622 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
58623 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
58624 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
58625 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
58627 - esr-system-info-id
58632 esr-system-info-id:
58634 description: Unique ID of esr system info.
58637 description: name of external system.
58640 description: type of external systems.
58643 description: vendor of external systems.
58646 description: version of external systems.
58649 description: url used to access external systems.
58652 description: username used to access external systems.
58655 description: password used to access external systems.
58658 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
58661 description: protocol of third party SDNC, for example netconf/snmp.
58664 description: ca file content if enabled ssl on auth-url.
58667 description: Whether to verify VIM's certificate.
58670 description: service IP of ftp server.
58673 description: service port of ftp server.
58676 description: domain info for authentication.
58679 description: default tenant of VIM.
58682 description: ftp passive mode or not.
58685 description: resource or performance data file path.
58688 description: the status of external system.
58689 esr-system-info-list:
58691 Collection of persistent block-level external system auth info.
58696 $ref: "#/patchDefinitions/esr-system-info"
58697 esr-thirdparty-sdnc:
58699 Persist SDNC address information used by ONAP SDNC.
58700 ###### Related Nodes
58701 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
58702 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
58703 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58705 - thirdparty-sdnc-id
58707 thirdparty-sdnc-id:
58709 description: Unique ID of SDNC.
58712 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
58715 description: password used to access SDNC server.
58716 esr-thirdparty-sdnc-list:
58718 esr-thirdparty-sdnc:
58721 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
58724 Persist VNFM address information used by VF-C.
58725 ###### Related Nodes
58726 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
58727 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58733 description: Unique ID of VNFM.
58736 description: indecate the VIM to deploy VNF.
58739 description: certificate url of VNFM.
58745 $ref: "#/patchDefinitions/esr-vnfm"
58748 evc object is an optional child object of the Configuration object.
58749 ###### Related Nodes
58750 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
58756 description: Unique/key field for the evc object
58757 forwarding-path-topology:
58759 description: Point-to-Point, Multi-Point
58762 description: Commited Information Rate
58765 description: CIR units
58766 connection-diversity-group-id:
58768 description: Diversity Group ID
58771 description: formerly Performance Group
58772 esp-evc-circuit-id:
58774 description: EVC Circuit ID of ESP EVC
58777 description: Committed Information Rate (For ESP)
58780 description: CIR units (For ESP)
58783 description: Identifies ESP
58784 collector-pop-clli:
58786 description: Collector POP CLLI (from the hostname of the access pnf)
58787 inter-connect-type-ingress:
58789 description: Interconnect type on ingress side of EVC.
58790 tagmode-access-ingress:
58792 description: tagode for collector side of EVC
58793 tagmode-access-egress:
58795 description: tagMode for network side of EVC
58801 $ref: "#/patchDefinitions/evc"
58804 Namespace for external system.
58808 $ref: "#/patchDefinitions/esr-ems-list"
58811 $ref: "#/patchDefinitions/esr-vnfm-list"
58812 esr-thirdparty-sdnc-list:
58814 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
58817 Extra properties for inventory item for response list
58822 $ref: "#/patchDefinitions/extra-property"
58832 ###### Related Nodes
58833 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58834 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
58835 - FLAVOR cannot be deleted if linked to VSERVER
58843 description: Flavor id, expected to be unique across cloud-region.
58846 description: Flavor name
58850 description: Number of CPUs
58854 description: Amount of memory
58858 description: Disk space
58862 description: Amount of ephemeral disk space
58865 description: amount of swap space allocation
58868 description: whether flavor is available to all users or private to the tenant it was created in.
58871 description: URL to endpoint where AAI can get more details
58874 description: Boolean as to whether this flavor is no longer enabled
58877 Collection of openstack flavors.
58882 $ref: "#/patchDefinitions/flavor"
58885 Entity describing a sequenced segment of forwarding path
58886 ###### Related Nodes
58887 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
58888 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
58889 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
58890 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
58891 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
58892 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
58899 description: Unique ID of this segmentation
58902 description: ingress, intermediate, egress
58905 forwarder object is an optional child object of the Configuration object.
58906 ###### Related Nodes
58907 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
58913 description: Key for forwarder-evc object
58916 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
58919 description: Internal VLAN.
58922 description: SVLAN value for ingress of egress forwarder.
58925 description: CVLAN value for ingress of egress forwarder.
58931 $ref: "#/patchDefinitions/forwarder-evc"
58937 $ref: "#/patchDefinitions/forwarder"
58940 Entity that describes the sequenced forwarding path between interfaces of services or resources
58941 ###### Related Nodes
58942 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
58943 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
58944 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
58945 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
58946 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
58948 - forwarding-path-id
58949 - forwarding-path-name
58951 forwarding-path-id:
58953 description: Unique ID of this FP
58954 forwarding-path-name:
58956 description: Name of the FP
58962 $ref: "#/patchDefinitions/forwarding-path"
58965 General purpose VNF
58966 ###### Related Nodes
58967 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58968 - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
58969 - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58970 - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
58971 - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58972 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
58973 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58974 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
58975 - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
58976 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
58977 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
58978 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
58979 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
58980 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58981 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
58982 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58983 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58984 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58985 - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58986 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58987 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
58988 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
58989 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
58990 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58991 - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
58992 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
58993 - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
58994 - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
58995 - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
59002 - vnf-discriptor-name
59005 - is-closed-loop-disabled
59009 description: Unique id of VNF. This is unique across the graph.
59012 description: vnf instance id.
59015 description: Name of VNF.
59018 description: Alternate name of VNF.
59021 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.
59024 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
59025 regional-resource-zone:
59027 description: Regional way of organizing pservers, source of truth should define values
59030 description: Trigger for operational monitoring of this resource by Service Assurance systems.
59031 operational-status:
59033 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
59036 description: OBSOLETE - do not use
59039 description: Client should send valid enumerated value
59040 orchestration-status:
59042 description: Orchestration status of this VNF, used by MSO.
59045 vnf-discriptor-name:
59047 description: vnf discriptor name
59050 description: job id corresponding to vnf
59053 description: Heat stack id corresponding to this instance, managed by MSO
59056 description: Corresponds to the SDN-C catalog id used to configure this VCE
59059 description: identifier of managed by ATT or customer
59062 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
59063 ipv4-loopback0-address:
59065 description: v4 Loopback0 address
59068 description: v6 Loopback address
59069 management-v6-address:
59071 description: v6 management address
59075 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
59078 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
59082 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
59085 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
59089 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
59092 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
59096 description: number of associated SHD in vnf.
59100 description: number of vms in vnf.
59104 description: number of network in vnf.
59107 is-closed-loop-disabled:
59116 $ref: "#/patchDefinitions/generic-vnf"
59119 Openstack group-assignment used to store exclusivity groups (EG).
59120 ###### Related Nodes
59121 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59122 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
59123 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
59131 description: Group id, expected to be unique across cloud-region.
59134 description: Group type - the type of group this instance refers to
59137 description: Group name - name assigned to the group
59140 description: Group description - description of the group
59143 Collection of openstack group assignments
59148 $ref: "#/patchDefinitions/group-assignment"
59151 ###### Related Nodes
59152 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
59160 description: host-route id
59163 description: subnet prefix
59166 description: Could be ip-address, hostname, or service-instance
59169 description: Should be ip-address, hostname, or service-instance to match next-hop
59175 $ref: "#/patchDefinitions/host-route"
59178 Collection of HPA Capabilities
59183 $ref: "#/patchDefinitions/hpa-capability"
59186 Represents a HPA capability
59187 ###### Related Nodes
59188 - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
59189 - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59190 - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
59191 - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
59193 - hpa-capability-id
59198 description: UUID to uniquely identify a HPA capability
59201 description: Name of the HPACapability
59204 description: HPA schema version
59207 description: Hardware architecture
59208 hpa-feature-attributes:
59210 HPA Capability Feature attributes
59211 ###### Related Nodes
59212 - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
59214 - hpa-attribute-key
59218 description: name of the specific HPA attribute
59219 hpa-attribute-value:
59221 description: JSON string specifying the value, unit and type of the specific HPA attribute
59225 ###### Related Nodes
59226 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59227 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
59228 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
59229 - IMAGE cannot be deleted if linked to VSERVER
59230 - IMAGE is DELETED when these are DELETED METADATUM
59240 description: Image id, expected to be unique across cloud region
59243 description: Image name
59244 image-architecture:
59246 description: Operating system architecture.
59249 description: The common name of the operating system distribution in lowercase
59252 description: The operating system version as specified by the distributor.
59255 description: The application that the image instantiates.
59256 application-vendor:
59258 description: The vendor of the application.
59259 application-version:
59261 description: The version of the application.
59264 description: URL to endpoint where AAI can get more details
59267 Collectio of Openstack images.
59272 $ref: "#/patchDefinitions/image"
59273 include-node-filter:
59279 InstanceFilter for performing a named-query or model query
59282 InstanceFilters for performing a named-query or model query
59287 $ref: "#/patchDefinitions/instance-filter"
59290 General mechanism for grouping instances
59291 ###### Related Nodes
59292 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
59293 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59294 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59295 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59296 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59297 - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59298 - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59299 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59300 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59301 - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59302 - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59303 - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59305 - instance-group-role
59306 - model-invariant-id
59312 instance-group-role:
59314 description: role of the instance group.
59315 model-invariant-id:
59317 description: ASDC model id for this resource or service model.
59320 description: ASDC model version uid for this resource model.
59323 description: Instance Group ID, UUID assigned to this instance.
59326 description: Descriptive text to help identify the usage of this instance-group
59329 description: Only valid value today is lower case ha for high availability
59332 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
59335 Collection of openstack route table references
59340 $ref: "#/patchDefinitions/instance-group"
59345 $ref: "#/patchDefinitions/search"
59348 $ref: "#/patchDefinitions/actions"
59349 cloud-infrastructure:
59351 $ref: "#/patchDefinitions/cloud-infrastructure"
59354 $ref: "#/patchDefinitions/external-system"
59357 $ref: "#/patchDefinitions/business"
59358 service-design-and-creation:
59360 $ref: "#/patchDefinitions/service-design-and-creation"
59363 $ref: "#/patchDefinitions/network"
59366 $ref: "#/patchDefinitions/aai-internal"
59370 $ref: "#/patchDefinitions/aai-internal"
59373 inventory-item-type:
59375 inventory-item-link:
59377 inventory-item-data:
59380 $ref: "#/patchDefinitions/inventory-item-data"
59381 tagged-inventory-item-list:
59384 $ref: "#/patchDefinitions/tagged-inventory-item-list"
59385 inventory-item-data:
59391 inventory-response-item:
59393 Inventory item for response list
59399 $ref: "#/patchDefinitions/extra-properties"
59400 inventory-response-items:
59402 $ref: "#/patchDefinitions/inventory-response-items"
59403 inventory-response-items:
59405 Container for inventory items in response list
59407 inventory-response-item:
59410 $ref: "#/patchDefinitions/inventory-response-item"
59411 ipsec-configuration:
59413 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
59414 ###### Related Nodes
59415 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
59416 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
59417 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
59419 - ipsec-configuration-id
59421 ipsec-configuration-id:
59423 description: UUID of this configuration
59424 requested-vig-address-type:
59426 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
59427 requested-encryption-strength:
59429 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
59430 requested-dmz-type:
59432 description: ATT can offer a shared DMZ or a DMZ specific to a customer
59433 shared-dmz-network-address:
59435 description: Network address of shared DMZ
59436 requested-customer-name:
59438 description: If the DMZ is a custom DMZ, this field will indicate the customer information
59441 description: can be 1 or 2
59442 ikev1-authentication:
59444 description: Contains values like md5, sha1, sha256, sha384
59447 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
59450 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
59453 description: Group name defined in VIG for clients using aggressive mode
59456 description: pre-shared key for the above group name
59459 description: Lifetime for IKEv1 SA
59460 ipsec-authentication:
59462 description: md5, sha1, sha256, sha384
59465 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
59468 description: Life time for IPSec SA
59471 description: enable PFS or not
59474 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
59475 xauth-user-password:
59477 description: Encrypted using the Juniper $9$ algorithm
59480 description: The time between DPD probe
59483 description: Maximum number of DPD before claiming the tunnel is down
59484 ipsec-configurations:
59486 ipsec-configuration:
59489 $ref: "#/patchDefinitions/ipsec-configuration"
59498 Logical interfaces, e.g., a vnic.
59499 ###### Related Nodes
59500 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59501 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
59502 - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59503 - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59504 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
59505 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
59506 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
59507 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
59508 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
59509 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59510 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59511 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
59512 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
59513 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59514 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
59515 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
59524 description: Name given to the interface
59527 description: E.g., CUSTOMER, UPLINK, etc.
59530 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
59533 description: URL to endpoint where AAI can get more details
59536 description: ID of interface
59539 description: MAC address for the interface
59542 description: Name of the network
59545 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
59546 interface-description:
59548 description: Human friendly text regarding this interface.
59553 Collection of logical interfaces.
59558 $ref: "#/patchDefinitions/l-interface"
59559 l3-interface-ipv4-address-list:
59562 ###### Related Nodes
59563 - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59564 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59565 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59566 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59567 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59568 - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
59570 - l3-interface-ipv4-address
59572 l3-interface-ipv4-address:
59574 description: IP address
59575 l3-interface-ipv4-prefix-length:
59578 description: Prefix length, 32 for single address
59582 description: Inner VLAN tag
59586 description: Outer VLAN tag
59589 description: Indicator of fixed or floating address
59590 l3-interface-ipv6-address-list:
59593 ###### Related Nodes
59594 - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59595 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59596 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59597 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59598 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59599 - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
59601 - l3-interface-ipv6-address
59603 l3-interface-ipv6-address:
59605 description: IP address
59606 l3-interface-ipv6-prefix-length:
59609 description: Prefix length, 128 for single address
59613 description: Inner VLAN tag
59617 description: Outer VLAN tag
59620 description: Indicator of fixed or floating address
59623 Generic network definition
59624 ###### Related Nodes
59625 - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59626 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
59627 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
59628 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59629 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
59630 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59631 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59632 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59633 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59634 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59635 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59636 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59637 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
59638 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59639 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59640 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
59641 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
59646 - is-provider-network
59647 - is-shared-network
59648 - is-external-network
59652 description: Network ID, should be uuid. Unique across A&AI.
59655 description: Name of the network, governed by some naming convention..
59658 description: Type of the network - who defines these values?
59661 description: Role the network plans - who defines these values?
59662 network-technology:
59664 description: Network technology - who defines these values?
59665 neutron-network-id:
59667 description: Neutron network id of this Interface
59672 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
59673 network-role-instance:
59676 description: network role instance
59682 $ref: "#/patchDefinitions/l3-network"
59685 Link aggregate interface
59686 ###### Related Nodes
59687 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59688 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
59689 - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59690 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
59691 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
59692 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
59693 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
59694 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
59695 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
59696 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
59703 description: Name that identifies the link aggregate interface
59704 interface-description:
59706 description: Human friendly text regarding this interface.
59709 Collection of link aggregate interfaces.
59714 $ref: "#/patchDefinitions/lag-interface"
59717 LAG links can connect lag-interfaces
59718 ###### Related Nodes
59719 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
59720 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
59726 description: Alphabetical concatenation of lag-interface names
59729 Collection of link aggregation connections
59734 $ref: "#/patchDefinitions/lag-link"
59737 Metadata for license group.
59738 ###### Related Nodes
59739 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59740 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59747 description: Unique ID for the license group the resource belongs to, should be uuid.
59750 description: Unique ID of a license resource.
59753 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
59758 $ref: "#/patchDefinitions/license"
59761 describes a line-of-business
59762 ###### Related Nodes
59763 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
59765 - line-of-business-name
59767 line-of-business-name:
59769 description: Name of the line-of-business (product)
59772 Collection of lines-of-business
59777 $ref: "#/patchDefinitions/line-of-business"
59780 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
59781 ###### Related Nodes
59782 - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
59783 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
59784 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
59785 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59786 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
59787 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
59788 - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59789 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59790 - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
59791 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59792 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
59793 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
59794 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
59795 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59796 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59804 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
59809 description: Type of logical link, e.g., evc
59812 description: Captures the numeric part of the speed
59815 description: Captures the units corresponding to the speed
59818 description: v4, v6, or ds for dual stack
59821 description: For example, static or BGP
59824 Collection of logical connections
59829 $ref: "#/patchDefinitions/logical-link"
59832 Collection of metadatum (key/value pairs)
59837 $ref: "#/patchDefinitions/metadatum"
59841 ###### Related Nodes
59842 - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
59843 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
59844 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
59845 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
59846 - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59857 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
59858 ###### Related Nodes
59859 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59860 - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
59861 - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59862 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
59863 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
59864 - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
59865 - MODEL is DELETED when these are DELETED MODEL-VER
59867 - model-invariant-id
59870 model-invariant-id:
59872 description: Unique identifier corresponding to the main definition of a model in ASDC
59875 description: Type of the model, e.g., service, resource, widget, etc.
59876 model-and-named-query-search:
59878 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
59882 $ref: "#/patchDefinitions/query-parameters"
59885 $ref: "#/patchDefinitions/instance-filters"
59888 $ref: "#/patchDefinitions/secondary-filts"
59891 secondary-filter-cut-point:
59895 This is how we would capture constraints defining allowed sets of elements.
59896 ###### Related Nodes
59897 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59898 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
59899 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
59901 - model-constraint-uuid
59902 - constrained-element-set-uuid-to-replace
59904 model-constraint-uuid:
59906 constrained-element-set-uuid-to-replace:
59908 constrained-element-sets:
59911 $ref: "#/patchDefinitions/constrained-element-set"
59917 $ref: "#/patchDefinitions/model-constraint"
59920 Defines how other models combine to make up a higher-level model.
59921 ###### Related Nodes
59922 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
59923 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59924 - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
59925 - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59926 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59927 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59928 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59929 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
59931 - model-element-uuid
59932 - new-data-del-flag
59935 model-element-uuid:
59939 description: Indicates whether this element was created as part of instantiation from this model
59942 description: How many of this type of element are required/allowed
59950 $ref: "#/patchDefinitions/model-element"
59953 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
59954 ###### Related Nodes
59955 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59956 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
59957 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59958 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59959 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
59960 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
59968 description: Unique identifier corresponding to one version of a model in ASDC
59971 description: Name of the model, which can change from version to version.
59974 description: Version
59977 description: Description
59983 $ref: "#/patchDefinitions/model-ver"
59986 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
59991 $ref: "#/patchDefinitions/model"
59992 multicast-configuration:
59994 ###### Related Nodes
59995 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
59997 - multicast-configuration-id
59998 - multicast-protocol
60001 multicast-configuration-id:
60003 description: Unique id of multicast configuration.
60004 multicast-protocol:
60006 description: protocol of multicast configuration
60009 description: rp type of multicast configuration
60010 multicast-configurations:
60012 multicast configuration of generic-vnf ip-address
60014 multicast-configuration:
60017 $ref: "#/patchDefinitions/multicast-configuration"
60023 $ref: "#/patchDefinitions/named-query"
60027 ###### Related Nodes
60028 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60029 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
60030 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60031 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
60035 - named-query-version
60041 named-query-version:
60043 required-input-param:
60047 named-query-element:
60050 ###### Related Nodes
60051 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60052 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
60053 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60054 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60055 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60056 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60057 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
60059 - named-query-element-uuid
60061 named-query-element-uuid:
60063 property-collect-list:
60065 named-query-elements:
60067 named-query-element:
60070 $ref: "#/patchDefinitions/named-query-element"
60073 Namespace for network inventory resources.
60078 $ref: "#/patchDefinitions/logical-link"
60082 $ref: "#/patchDefinitions/site-pair-set"
60086 $ref: "#/patchDefinitions/vpn-binding"
60090 $ref: "#/patchDefinitions/vpls-pe"
60091 multicast-configurations:
60094 $ref: "#/patchDefinitions/multicast-configuration"
60098 $ref: "#/patchDefinitions/vce"
60102 $ref: "#/patchDefinitions/vnfc"
60106 $ref: "#/patchDefinitions/l3-network"
60110 $ref: "#/patchDefinitions/network-policy"
60114 $ref: "#/patchDefinitions/generic-vnf"
60118 $ref: "#/patchDefinitions/lag-link"
60122 $ref: "#/patchDefinitions/newvce"
60126 $ref: "#/patchDefinitions/pnf"
60130 $ref: "#/patchDefinitions/physical-link"
60131 ipsec-configurations:
60134 $ref: "#/patchDefinitions/ipsec-configuration"
60135 route-table-references:
60138 $ref: "#/patchDefinitions/route-table-reference"
60142 $ref: "#/patchDefinitions/instance-group"
60146 $ref: "#/patchDefinitions/zone"
60150 $ref: "#/patchDefinitions/configurations"
60156 $ref: "#/patchDefinitions/network-policy"
60159 ###### Related Nodes
60160 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
60161 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
60163 - network-policy-id
60167 description: UUID representing unique key to this instance
60168 network-policy-fqdn:
60170 description: Contrail FQDN for the policy
60173 description: ID for the openStack Heat instance
60176 Network profile populated by SDN-GP for SNMP
60177 ###### Related Nodes
60178 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
60184 description: Unique name of network profile.
60187 description: Encrypted SNMP community string
60190 Collection of network profiles
60195 $ref: "#/patchDefinitions/network-profile"
60198 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
60199 ###### Related Nodes
60200 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
60201 - NEWVCE is DELETED when these are DELETED L-INTERFACE
60209 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
60212 description: Name of VNF.
60215 description: Alternate name of VNF.
60218 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.
60221 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60222 operational-status:
60224 description: Indicator for whether the resource is considered operational
60227 description: OBSOLETE - do not use
60230 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
60233 description: Client should send valid enumerated value.
60236 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
60241 $ref: "#/patchDefinitions/newvce"
60242 notification-event:
60246 notification-event-header:
60248 $ref: "#/patchDefinitions/notification-event-header"
60249 notification-event-header:
60290 $ref: "#/patchDefinitions/key-data"
60295 OAM network, to be deprecated shortly. Do not use for new purposes.
60296 ###### Related Nodes
60297 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60298 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
60299 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60307 description: UUID of the network. Unique across a cloud-region
60310 description: Name of the network.
60314 description: cvlan-id
60315 ipv4-oam-gateway-address:
60317 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60318 ipv4-oam-gateway-address-prefix-length:
60321 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60324 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
60329 $ref: "#/patchDefinitions/oam-network"
60330 operational-environment:
60332 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
60333 ###### Related Nodes
60334 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
60335 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
60337 - operational-environment-id
60338 - operational-environment-name
60339 - operational-environment-type
60340 - operational-environment-status
60344 operational-environment-id:
60346 description: UUID of an operational environment
60347 operational-environment-name:
60349 description: Operational Environment name
60350 operational-environment-type:
60352 description: Operational Environment Type.
60353 operational-environment-status:
60355 description: Status
60358 description: Tenant Context.
60361 description: Workload Context.
60362 operational-environments:
60364 a logical partition of the cloud which allows to have multiple environments in the production AIC.
60366 operational-environment:
60369 $ref: "#/patchDefinitions/operational-environment"
60372 Allows for legacy POST of old-style and new-style models
60374 - model-invariant-id
60375 - model-name-version-id
60381 model-invariant-id:
60383 description: Unique identifier corresponding to the main definition of a model in ASDC
60384 model-name-version-id:
60386 description: Unique identifier corresponding to one version of a model in ASDC
60389 description: Type of the model, e.g., service, resource, widget, etc.
60392 description: Name of the model, which can change from version to version.
60395 description: Invariant unique ID which does not change from version to version
60398 description: Version
60401 description: Description
60404 Collection of owning-entities
60409 $ref: "#/patchDefinitions/owning-entity"
60412 describes an owning-entity
60413 ###### Related Nodes
60414 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
60417 - owning-entity-name
60421 description: UUID of an owning entity
60422 owning-entity-name:
60424 description: Owning entity name
60427 Physical interface (e.g., nic)
60428 ###### Related Nodes
60429 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
60430 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
60431 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60432 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60433 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
60434 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
60435 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
60436 - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
60437 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
60438 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
60445 description: Name that identifies the physical interface
60448 description: Captures the numeric part of the speed
60451 description: Captures the units corresponding to the speed
60454 description: Nature of the services and connectivity on this port.
60455 equipment-identifier:
60457 description: CLEI or other specification for p-interface hardware.
60460 description: Role specification for p-interface hardware.
60463 description: Indicates the physical properties of the interface.
60466 description: Trigger for operational monitoring of this resource by Service Assurance systems.
60469 description: MAC Address of the p-interface.
60472 Collection of physical interfaces.
60477 $ref: "#/patchDefinitions/p-interface"
60480 Collection of physical connections, typically between p-interfaces
60481 ###### Related Nodes
60482 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
60488 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
60491 description: Captures the numeric part of the speed
60494 description: Captures the units corresponding to the speed
60497 description: Circuit it
60500 description: Dual access mode (e.g., primary, secondary
60503 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
60504 service-provider-name:
60506 description: Name of the service Provider on this link.
60507 service-provider-bandwidth-up-value:
60510 description: Upstream Bandwidth value agreed with the service provider
60511 service-provider-bandwidth-up-units:
60513 description: Units for the upstream BW value
60514 service-provider-bandwidth-down-value:
60517 description: Downstream Bandwidth value agreed with the service provider
60518 service-provider-bandwidth-down-units:
60520 description: Units for downstream BW value
60523 Collection of physical connections, typically between p-interfaces
60528 $ref: "#/patchDefinitions/physical-link"
60531 describes a platform
60532 ###### Related Nodes
60533 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
60539 description: Name of the platform
60542 Collection of platforms
60547 $ref: "#/patchDefinitions/platform"
60550 PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
60551 ###### Related Nodes
60552 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60553 - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60554 - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60555 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
60556 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
60557 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
60558 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60559 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60560 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
60561 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
60568 description: unique name of Physical Network Function.
60571 description: name of Physical Network Function.
60574 description: source of name2
60577 description: id of pnf
60580 description: Equipment type. Source of truth should define valid values.
60583 description: Equipment vendor. Source of truth should define valid values.
60586 description: Equipment model. Source of truth should define valid values.
60589 description: identifier of managed by ATT or customer
60592 description: ipv4-oam-address with new naming convention for IP addresses
60595 description: sw-version is the version of SW for the hosted application on the PNF.
60600 description: ID of the physical frame (relay rack) where pnf is installed.
60603 description: Serial number of the device
60604 ipaddress-v4-loopback-0:
60606 description: IPV4 Loopback 0 address
60607 ipaddress-v6-loopback-0:
60609 description: IPV6 Loopback 0 address
60612 description: IPV4 AIM address
60615 description: IPV6 AIM address
60618 description: IPV6 OAM address
60621 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
60624 Collection of Physical Network Functions.
60629 $ref: "#/patchDefinitions/pnf"
60632 Used to capture the network interfaces of this VCE
60633 ###### Related Nodes
60634 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
60635 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
60636 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
60639 - orchestration-status
60643 description: Unique ID of the interface
60644 neutron-network-id:
60646 description: Neutron network id of this Interface
60647 neutron-network-name:
60649 description: Neutron network name of this Interface
60652 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
60658 $ref: "#/patchDefinitions/port-group"
60661 describes the project
60662 ###### Related Nodes
60663 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
60669 description: Name of the project deploying a service
60672 Collection of projects
60677 $ref: "#/patchDefinitions/project"
60680 Property holder for query properties or instance properties
60686 property-constraint:
60689 ###### Related Nodes
60690 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60692 - property-constraint-uuid
60697 property-constraint-uuid:
60705 property-constraints:
60707 property-constraint:
60710 $ref: "#/patchDefinitions/property-constraint"
60713 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
60714 ###### Related Nodes
60715 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
60716 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
60717 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
60718 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60719 - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60720 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
60721 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
60722 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60723 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60724 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
60725 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
60726 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
60727 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
60734 description: Value from executing hostname on the compute node.
60737 description: PTNII name
60741 description: Number of cpus
60745 description: Disk size, in GBs
60749 description: RAM size, in MBs
60752 description: Equipment type. Source of truth should define valid values.
60755 description: Equipment vendor. Source of truth should define valid values.
60758 description: Equipment model. Source of truth should define valid values.
60761 description: Fully-qualified domain name
60764 description: URL to endpoint where AAI can get more details
60767 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
60770 description: Serial number, may be queried
60771 ipaddress-v4-loopback-0:
60773 description: IPV4 Loopback 0 address
60774 ipaddress-v6-loopback-0:
60776 description: IPV6 Loopback 0 address
60779 description: IPV4 AIM address
60782 description: IPV6 AIM address
60785 description: IPV6 OAM address
60788 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
60791 description: ID of Pserver
60794 description: internet topology of Pserver
60799 Collection of compute hosts.
60804 $ref: "#/patchDefinitions/pserver"
60807 QueryParameters for performing a named-query or model query
60811 $ref: "#/patchDefinitions/named-query"
60814 $ref: "#/patchDefinitions/overloaded-model"
60818 ###### Related Nodes
60819 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60821 - related-lookup-uuid
60823 - source-node-property
60825 - target-node-property
60827 related-lookup-uuid:
60831 source-node-property:
60835 target-node-property:
60837 property-collect-list:
60844 $ref: "#/patchDefinitions/related-lookup"
60845 related-to-property:
60849 description: Key part of a key/value pair
60852 description: Value part of a key/value pair
60857 description: A keyword provided by A&AI to indicate type of node.
60860 description: URL to the object in A&AI.
60864 $ref: "#/patchDefinitions/relationship-data"
60865 related-to-property:
60868 $ref: "#/patchDefinitions/related-to-property"
60872 - relationship-value
60876 description: A keyword provided by A&AI to indicate an attribute.
60877 relationship-value:
60879 description: Value of the attribute.
60880 reserved-prop-names:
60882 Internal map to define some reserved properties of a vertex
60884 last-mod-source-of-truth:
60902 Response container for the results of a named-query or model query
60904 inventory-response-items:
60906 $ref: "#/patchDefinitions/inventory-response-items"
60911 description: The specific type of node in the A&AI graph
60914 description: The URL to the specific resource
60915 route-table-reference:
60917 Openstack route table reference.
60918 ###### Related Nodes
60919 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
60921 - route-table-reference-id
60922 - route-table-reference-fqdn
60924 route-table-reference-id:
60926 description: Route Table Reference id, UUID assigned to this instance.
60927 route-table-reference-fqdn:
60929 description: FQDN entry in the route table.
60930 route-table-references:
60932 Collection of openstack route table references
60934 route-table-reference:
60937 $ref: "#/patchDefinitions/route-table-reference"
60940 Route target information
60941 ###### Related Nodes
60942 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
60944 - global-route-target
60945 - route-target-role
60947 global-route-target:
60949 description: Number used to identify an RT, globally unique in the network
60952 description: Role assigned to this route target
60955 Collection of route target information
60960 $ref: "#/patchDefinitions/route-target"
60963 ###### Related Nodes
60964 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
60965 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
60966 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
60968 - routing-instance-id
60970 routing-instance-id:
60972 description: Unique id of routing instance
60975 description: rpm owner
60978 set of probes related to generic-vnf routing instance
60983 $ref: "#/patchDefinitions/routing-instance"
60988 $ref: "#/patchDefinitions/oam-networks"
60989 az-and-dvs-switches:
60992 $ref: "#/patchDefinitions/az-and-dvs-switches"
60995 edge-tag-query-result:
60997 $ref: "#/patchDefinitions/edge-tag-query-result"
60998 edge-tag-query-request:
61000 $ref: "#/patchDefinitions/edge-tag-query-request"
61003 $ref: "#/patchDefinitions/search-results"
61006 $ref: "#/patchDefinitions/sdn-zone-response"
61012 $ref: "#/patchDefinitions/result-data"
61015 SecondaryFilt for performing a named-query or model query
61026 SecondaryFilts for performing a named-query or model query
61031 $ref: "#/patchDefinitions/secondary-filt"
61032 segmentation-assignment:
61034 Openstack segmentation assignment.
61035 ###### Related Nodes
61036 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61042 description: Route Table Reference id, UUID assigned to this instance.
61043 segmentation-assignments:
61045 Collection of openstack segmentation assignments
61047 segmentation-assignment:
61050 $ref: "#/patchDefinitions/segmentation-assignment"
61053 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
61056 - service-description
61060 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61061 service-description:
61063 description: Description of the service
61066 description: URL to endpoint where AAI can get more details
61067 service-capabilities:
61069 Collection of service capabilities.
61071 service-capability:
61074 $ref: "#/patchDefinitions/service-capability"
61075 service-capability:
61077 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
61078 ###### Related Nodes
61079 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
61080 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
61081 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
61088 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61091 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.
61092 service-design-and-creation:
61094 Namespace for objects managed by ASDC
61099 $ref: "#/patchDefinitions/vnf-image"
61103 $ref: "#/patchDefinitions/service"
61104 service-capabilities:
61107 $ref: "#/patchDefinitions/service-capability"
61111 $ref: "#/patchDefinitions/model"
61115 $ref: "#/patchDefinitions/named-query"
61118 Instance of a service
61119 ###### Related Nodes
61120 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
61121 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
61122 - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
61123 - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
61124 - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
61125 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
61126 - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
61127 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
61128 - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61129 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
61130 - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
61131 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
61132 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
61133 - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61134 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
61135 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
61136 - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
61137 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
61138 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
61139 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
61140 - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
61141 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61143 - service-instance-id
61150 service-instance-id:
61152 description: Uniquely identifies this instance of a service
61153 service-instance-name:
61155 description: This field will store a name assigned to the service-instance.
61158 description: String capturing type of service.
61161 description: String capturing the service role.
61162 environment-context:
61164 description: This field will store the environment context assigned to the service-instance.
61167 description: This field will store the workload context assigned to the service-instance.
61170 description: create time of Network Service.
61173 description: last update of Network Service.
61176 description: short description for service-instance.
61177 model-invariant-id:
61179 description: the ASDC model id for this resource or service model.
61182 description: the ASDC model version for this resource or service model.
61183 persona-model-version:
61185 description: the ASDC model version for this resource or service model.
61188 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61189 widget-model-version:
61191 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61194 description: Indicates the total bandwidth to be used for this service.
61197 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
61198 bandwidth-down-wan1:
61200 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
61203 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
61204 bandwidth-down-wan2:
61206 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
61209 description: URL customers will use to access the vHN Portal.
61210 service-instance-location-id:
61212 description: An identifier that customers assign to the location where this service is being used.
61215 Collection of service instances
61220 $ref: "#/patchDefinitions/service-instance"
61221 service-subscription:
61223 Object that group service instances.
61224 ###### Related Nodes
61225 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
61226 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
61227 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
61228 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
61234 description: Value defined by orchestration to identify this service across ECOMP.
61235 temp-ub-sub-account-id:
61237 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
61238 service-subscriptions:
61240 Collection of objects that group service instances.
61242 service-subscription:
61245 $ref: "#/patchDefinitions/service-subscription"
61248 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
61253 $ref: "#/patchDefinitions/service"
61256 ###### Related Nodes
61257 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
61258 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
61259 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
61265 description: unique identifier of probe
61268 description: Prefix address
61271 description: Prefix address
61274 description: ip version, v4, v6
61275 destination-hostname:
61277 description: Hostname of the destination equipment to which SLAs are measured against.
61278 destination-equip-type:
61280 description: The type of destinatination equipment. Could be Router, UCPE, etc.
61283 Set of instances for probes used to measure service level agreements
61284 ###### Related Nodes
61285 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
61286 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
61287 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
61293 description: Unique id of site pair set.
61296 Collection of sets of instances for probes related to generic-vnf
61301 $ref: "#/patchDefinitions/site-pair-set"
61309 $ref: "#/patchDefinitions/site-pair"
61313 ###### Related Nodes
61314 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61315 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
61321 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
61324 description: Snapshot name
61325 snapshot-architecture:
61327 description: Operating system architecture
61328 snapshot-os-distro:
61330 description: The common name of the operating system distribution in lowercase
61331 snapshot-os-version:
61333 description: The operating system version as specified by the distributor.
61336 description: The application that the image instantiates.
61337 application-vendor:
61339 description: The vendor of the application.
61340 application-version:
61342 description: The version of the application.
61345 description: URL to endpoint where AAI can get more details
61348 description: This field contains the UUID of the previous snapshot (if any).
61351 Collection of openstack snapshots
61356 $ref: "#/patchDefinitions/snapshot"
61359 SR-IOV Physical Function
61360 ###### Related Nodes
61361 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
61362 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
61368 description: Identifier for the sriov-pf
61371 Collection of SR-IOV Physical Functions.
61376 $ref: "#/patchDefinitions/sriov-pf"
61379 SR-IOV Virtual Function (not to be confused with virtual network function)
61380 ###### Related Nodes
61381 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
61382 - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
61388 description: PCI ID used to identify the sriov-vf
61391 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
61394 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
61397 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
61398 vf-vlan-anti-spoof-check:
61400 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.
61401 vf-mac-anti-spoof-check:
61403 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.
61406 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
61407 vf-broadcast-allow:
61409 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
61410 vf-unknown-multicast-allow:
61412 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
61413 vf-unknown-unicast-allow:
61415 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
61418 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
61421 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
61424 Collection of SR-IOV Virtual Functions.
61429 $ref: "#/patchDefinitions/sriov-vf"
61438 ###### Related Nodes
61439 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61440 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61441 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61442 - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
61443 - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61444 - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61445 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
61446 - SUBNET is DELETED when these are DELETED HOST-ROUTE
61453 description: Subnet ID, should be UUID.
61456 description: Name associated with the subnet.
61459 description: Neutron id of this subnet
61462 description: gateway ip address
61463 network-start-address:
61465 description: network start address
61468 description: cidr mask
61471 description: ip version
61472 orchestration-status:
61474 description: Orchestration status of this VNF, mastered by MSO
61479 description: the start address reserved for use by dhcp
61482 description: the last address reserved for use by dhcp
61485 description: role of the subnet, referenced when assigning IPs
61486 ip-assignment-direction:
61488 description: ip address assignment direction of the subnet
61494 $ref: "#/patchDefinitions/subnet"
61495 tagged-inventory-item-list:
61500 $ref: "#/patchDefinitions/inventory-item"
61504 ###### Related Nodes
61505 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61506 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
61507 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61508 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61509 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
61510 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
61511 - TENANT cannot be deleted if linked to VSERVER
61518 description: Unique id relative to the cloud-region.
61521 description: Readable name of tenant
61524 description: This field will store the tenant context.
61527 Collection of openstack tenants.
61532 $ref: "#/patchDefinitions/tenant"
61535 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
61536 ###### Related Nodes
61537 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
61540 - bandwidth-up-wan1
61541 - bandwidth-down-wan1
61542 - bandwidth-up-wan2
61543 - bandwidth-down-wan2
61547 description: Allotted Resource id UUID assigned to this instance.
61550 description: The WAN uplink bandwidth for WAN1
61551 bandwidth-down-wan1:
61553 description: The WAN downlink bandwidth for WAN1
61556 description: The WAN uplink bandwidth for WAN2
61557 bandwidth-down-wan2:
61559 description: The WAN downlink bandwidth for WAN2
61562 This object is used to store the specific tunnel cross connect aspects of an allotted resource
61567 $ref: "#/patchDefinitions/tunnel-xconnect"
61570 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
61579 $ref: "#/patchDefinitions/update-node-key"
61585 $ref: "#/patchDefinitions/action"
61594 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
61595 ###### Related Nodes
61596 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
61597 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
61598 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
61599 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61600 - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61601 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61602 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
61603 - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
61611 description: Unique id of VNF. This is unique across the graph.
61614 description: Name of VNF.
61617 description: Alternate name of VNF.
61620 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.
61623 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
61624 regional-resource-zone:
61626 description: Regional way of organizing pservers, source of truth should define values
61629 description: Trigger for operational monitoring of this resource by Service Assurance systems.
61630 operational-status:
61632 description: Indicator for whether the resource is considered operational
61635 description: OBSOLETE - do not use
61638 description: Network role being played by this VNF
61639 orchestration-status:
61641 description: Orchestration status of this VNF, mastered by MSO
61644 description: Heat stack id corresponding to this instance, managed by MSO
61647 description: Corresponds to the SDN-C catalog id used to configure this VCE
61650 description: Unique ID of VPE connected to this VCE.
61651 v6-vce-wan-address:
61653 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
61656 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
61659 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
61664 $ref: "#/patchDefinitions/vce"
61667 a deployment unit of VNFCs
61668 ###### Related Nodes
61669 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61670 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
61671 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
61672 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
61673 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
61674 - VF-MODULE cannot be deleted if linked to VNFC
61677 - is-base-vf-module
61681 description: Unique ID of vf-module.
61684 description: Name of vf-module
61687 description: Heat stack id corresponding to this instance.
61688 orchestration-status:
61690 description: orchestration status of this vf-module, mastered by MSO
61695 Collection of vf-modules, a deployment unit of VNFCs
61700 $ref: "#/patchDefinitions/vf-module"
61703 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
61704 ###### Related Nodes
61705 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
61711 description: indicates whether the VIG is for AVPN or INTERNET
61714 description: v4 IP of the vig server
61717 description: v6 IP of the vig server
61723 $ref: "#/patchDefinitions/vig-server"
61724 vip-ipv4-address-list:
61727 ###### Related Nodes
61728 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61729 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61730 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61731 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
61737 description: IP address
61738 vip-ipv4-prefix-length:
61741 description: Prefix length, 32 for single address
61745 description: Inner VLAN tag
61749 description: Outer VLAN tag
61752 description: Indicator of fixed or floating address
61753 vip-ipv6-address-list:
61756 ###### Related Nodes
61757 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61758 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61759 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61760 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
61766 description: IP address
61767 vip-ipv6-prefix-length:
61770 description: Prefix length, 128 for single address
61774 description: Inner VLAN tag
61778 description: Outer VLAN tag
61781 description: Indicator of fixed or floating address
61782 virtual-data-center:
61784 Virtual organization of cloud infrastructure elements in a data center context
61785 ###### Related Nodes
61786 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61787 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61788 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61795 description: Unique ID of the vdc
61798 description: Name of the virtual data center
61799 virtual-data-centers:
61801 Virtual organization of cloud infrastructure elements in a data center context
61803 virtual-data-center:
61806 $ref: "#/patchDefinitions/virtual-data-center"
61810 ###### Related Nodes
61811 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
61812 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61813 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
61814 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
61815 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
61816 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61817 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61818 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
61819 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61827 description: String that identifies the interface
61831 description: Inner VLAN tag
61835 description: Outer VLAN tag
61841 $ref: "#/patchDefinitions/vlan"
61850 description: Unique id of VNF. This is unique across the graph.
61853 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
61854 ###### Related Nodes
61855 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
61856 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
61860 - application-vendor
61864 description: Unique ID of this asset
61867 description: The application that the image instantiates.
61868 application-vendor:
61870 description: The vendor of the application.
61871 application-version:
61873 description: The version of the application.
61876 description: URL to endpoint where AAI can get more details
61879 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
61884 $ref: "#/patchDefinitions/vnf-image"
61887 ###### Related Nodes
61888 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61889 - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61890 - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
61891 - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
61892 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
61893 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
61894 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
61895 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
61896 - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
61902 - is-closed-loop-disabled
61906 description: Unique ID of vnfc.
61909 description: Short code that is used in naming instances of the item being modeled
61912 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
61915 description: prov status of this vnfc
61916 orchestration-status:
61918 description: Orchestration status of this VNF, mastered by APP-C
61919 ipaddress-v4-oam-vip:
61921 description: Oam V4 vip address of this vnfc
61924 is-closed-loop-disabled:
61928 description: Group notation of VNFC
61929 model-invariant-id:
61931 description: the ASDC model id for this resource or service model.
61934 description: the ASDC model version for this resource or service model.
61937 virtual network components associated with a vserver from application controller.
61942 $ref: "#/patchDefinitions/vnfc"
61945 Ephemeral Block storage volume.
61946 ###### Related Nodes
61947 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
61954 description: Unique ID of block storage volume relative to the vserver.
61957 description: URL to endpoint where AAI can get more details
61960 Persistent block-level storage.
61961 ###### Related Nodes
61962 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61963 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61964 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61965 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
61966 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61969 - volume-group-name
61974 description: Unique ID of volume-group.
61977 description: Name of the volume group.
61980 description: Heat stack id corresponding to this volume-group
61983 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.
61984 orchestration-status:
61986 description: Orchestration status of this volume-group
61987 model-customization-id:
61989 description: captures the id of all the configuration used to customize the resource for the service.
61990 vf-module-model-customization-id:
61992 description: helps relate the volume group to the vf-module whose components will require the volume group
61995 Collection of persistent block-level storage.
62000 $ref: "#/patchDefinitions/volume-group"
62003 Collection of ephemeral Block storage volumes.
62008 $ref: "#/patchDefinitions/volume"
62011 VPLS Provider Edge routers.
62012 ###### Related Nodes
62013 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62014 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
62015 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62016 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62017 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
62025 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62028 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
62031 description: Client should send valid enumerated value, e.g., VPLS-PE.
62035 description: Temporary location for stag to get to VCE
62038 Collection of VPLS Provider Edge routers
62043 $ref: "#/patchDefinitions/vpls-pe"
62047 ###### Related Nodes
62048 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
62049 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
62050 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
62051 - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
62052 - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
62053 - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
62060 description: VPN ID, globally unique within A&AI
62063 description: VPN Name
62066 description: the platform associated with the VPN example AVPN, Mobility
62069 description: Type of the vpn, should be taken from enumerated/valid values
62072 description: region of customer vpn
62075 description: id for this customer vpn
62076 route-distinguisher:
62078 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
62084 $ref: "#/patchDefinitions/vpn-binding"
62087 Virtual Servers, aka virtual machine or VM.
62088 ###### Related Nodes
62089 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
62090 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
62091 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
62092 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
62093 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
62094 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
62095 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
62096 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
62097 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
62098 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
62099 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
62100 - VSERVER is DELETED when these are DELETED L-INTERFACE
62101 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
62107 - is-closed-loop-disabled
62111 description: Unique identifier for this vserver relative to its tenant
62114 description: Name of vserver
62117 description: Alternative name of vserver
62120 description: Trigger for operational monitoring of this resource by Service Assurance systems.
62123 description: URL to endpoint where AAI can get more details
62126 is-closed-loop-disabled:
62130 Collection of virtual Servers, aka virtual machines or VMs.
62135 $ref: "#/patchDefinitions/vserver"
62138 A zone is a grouping of assets in a location homing to the same connections into the CBB
62139 ###### Related Nodes
62140 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62141 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62142 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62143 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62144 - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62153 description: Code assigned by AIC to the zone
62156 description: English name associated with the zone
62159 description: Design of zone [Medium/Large?]
62162 description: Context of zone [production/test]
62165 description: Status of a zone.
62168 Collection of zones
62173 $ref: "#/patchDefinitions/zone"
62188 $ref: "#/getDefinitions/action-data"
62197 APIs that are more action related than REST (e.g., notify, update).
62201 $ref: "#/getDefinitions/update"
62204 $ref: "#/getDefinitions/notify"
62207 Represents a slice or partial piece of a resource that gets separately allotted
62208 ###### Related Nodes
62209 - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
62210 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
62211 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62212 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
62213 - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
62214 - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
62215 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
62216 - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
62217 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
62218 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
62219 - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
62220 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
62221 - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
62222 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
62228 description: Allotted Resource id UUID assigned to this instance.
62231 description: The descriptive information assigned to this allotted resource instance
62234 description: Link back to more information in the controller
62235 model-invariant-id:
62237 description: the ASDC model id for this resource or service model.
62240 description: the ASDC model version for this resource or service model.
62241 persona-model-version:
62243 description: the ASDC model version for this resource or service model.
62246 description: Concurrency value
62247 orchestration-status:
62249 description: Orchestration status
62250 operational-status:
62252 description: Indicator for whether the resource is considered operational
62255 description: Generic description of the type of allotted resource.
62258 description: role in the network that this resource will be providing.
62262 $ref: "#/getDefinitions/tunnel-xconnect"
62266 $ref: "#/getDefinitions/relationship"
62267 allotted-resources:
62269 This object is used to store slices of services being offered
62274 $ref: "#/getDefinitions/allotted-resource"
62277 Availability zone, a collection of compute hosts/pservers
62278 ###### Related Nodes
62279 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62280 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
62281 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62282 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
62283 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
62284 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
62285 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
62286 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
62287 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
62289 - availability-zone-name
62292 availability-zone-name:
62294 description: Name of the availability zone. Unique across a cloud region
62297 description: Type of hypervisor. Source of truth should define valid values.
62298 operational-status:
62300 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
62303 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62307 $ref: "#/getDefinitions/relationship"
62308 availability-zones:
62310 Collection of availability zones
62315 $ref: "#/getDefinitions/availability-zone"
62316 az-and-dvs-switches:
62320 $ref: "#/getDefinitions/dvs-switches"
62323 $ref: "#/getDefinitions/availability-zone"
62326 Namespace for business related constructs
62331 $ref: "#/getDefinitions/connector"
62335 $ref: "#/getDefinitions/customer"
62339 $ref: "#/getDefinitions/line-of-business"
62343 $ref: "#/getDefinitions/owning-entity"
62347 $ref: "#/getDefinitions/platform"
62351 $ref: "#/getDefinitions/project"
62354 ###### Related Nodes
62355 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
62361 description: unique identifier of probe
62364 description: identifier of probe
62367 description: type of probe
62370 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62374 $ref: "#/getDefinitions/relationship"
62375 classes-of-service:
62377 class-of-service of probe
62382 $ref: "#/getDefinitions/class-of-service"
62383 cloud-infrastructure:
62385 Namespace for cloud infrastructure.
62390 $ref: "#/getDefinitions/complex"
62394 $ref: "#/getDefinitions/cloud-region"
62398 $ref: "#/getDefinitions/network-profile"
62402 $ref: "#/getDefinitions/pserver"
62403 virtual-data-centers:
62406 $ref: "#/getDefinitions/virtual-data-center"
62409 cloud-region designates an installation of a cloud cluster or region or instantiation.
62410 ###### Related Nodes
62411 - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
62412 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62413 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
62414 - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62415 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62416 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62417 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62418 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62419 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62420 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62421 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62422 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62423 - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62424 - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62425 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62426 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
62427 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
62428 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
62429 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
62430 - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
62438 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
62441 description: Identifier used by the vendor for the region. Second part of composite key
62444 description: Type of the cloud (e.g., openstack)
62445 owner-defined-type:
62447 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
62448 cloud-region-version:
62450 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
62453 description: URL of the keystone identity service
62456 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
62459 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
62464 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
62467 description: MultiVIM will discover and expose EPA capabilities.
62470 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62474 $ref: "#/getDefinitions/volume-group"
62478 $ref: "#/getDefinitions/tenant"
62482 $ref: "#/getDefinitions/flavor"
62486 $ref: "#/getDefinitions/group-assignment"
62490 $ref: "#/getDefinitions/snapshot"
62494 $ref: "#/getDefinitions/image"
62498 $ref: "#/getDefinitions/dvs-switch"
62502 $ref: "#/getDefinitions/oam-network"
62503 availability-zones:
62506 $ref: "#/getDefinitions/availability-zone"
62510 $ref: "#/getDefinitions/relationship"
62511 esr-system-info-list:
62514 $ref: "#/getDefinitions/esr-system-info"
62515 vip-ipv4-address-list:
62518 $ref: "#/getDefinitions/vip-ipv4-address-list"
62519 vip-ipv6-address-list:
62522 $ref: "#/getDefinitions/vip-ipv6-address-list"
62528 $ref: "#/getDefinitions/cloud-region"
62531 Collection of physical locations that can house cloud-regions.
62532 ###### Related Nodes
62533 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
62534 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62535 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62536 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
62537 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
62538 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
62539 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62540 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62541 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
62542 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62543 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62544 - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62545 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
62546 - COMPLEX is DELETED when these are DELETED CTAG-POOL
62548 - physical-location-id
62549 - physical-location-type
62556 physical-location-id:
62558 description: Unique identifier for physical location, e.g., CLLI
62561 description: Data center code which can be an alternate way to identify a complex
62564 description: Gamma complex name for LCP instance.
62567 description: URL of the keystone identity service
62570 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62571 physical-location-type:
62573 description: Type, e.g., central office, data center.
62599 $ref: "#/getDefinitions/ctag-pool"
62603 $ref: "#/getDefinitions/relationship"
62606 Collection of physical locations that can house cloud-regions.
62611 $ref: "#/getDefinitions/complex"
62614 Port Mirror Configuration.
62615 ###### Related Nodes
62616 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
62617 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
62618 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
62619 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
62620 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
62621 - CONFIGURATION is DELETED when these are DELETED METADATUM
62622 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
62625 - configuration-type
62626 - configuration-sub-type
62627 - orchestration-status
62628 - operational-status
62629 - configuration-selflink
62630 - model-customization-id
62634 description: UUID assigned to configuration.
62637 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
62638 configuration-name:
62640 description: Name of the configuration.
62641 configuration-type:
62643 description: port-mirroring-configuration.
62644 configuration-sub-type:
62646 description: vprobe, pprobe.
62647 model-invariant-id:
62649 description: the ASDC model id for this resource or service model.
62652 description: the ASDC model version for this resource or service model.
62653 orchestration-status:
62655 description: Orchestration status of the configuration.
62656 operational-status:
62658 description: Indicator for whether the resource is considered operational.
62659 configuration-selflink:
62661 description: URL to endpoint where AAI can get more details from SDN-GC.
62662 model-customization-id:
62664 description: id of the configuration used to customize the resource
62667 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62671 $ref: "#/getDefinitions/relationship"
62675 $ref: "#/getDefinitions/metadatum"
62678 Collection of configurations
62683 $ref: "#/getDefinitions/configuration"
62686 Collection of resource instances used to connect a variety of disparate inventory widgets
62687 ###### Related Nodes
62688 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62689 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
62690 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
62691 - CONNECTOR is DELETED when these are DELETED METADATUM
62693 - resource-instance-id
62695 resource-instance-id:
62697 description: Unique id of resource instance.
62700 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62701 model-invariant-id:
62703 description: the ASDC model id for this resource or service model.
62706 description: the ASDC model version for this resource or service model.
62707 persona-model-version:
62709 description: the ASDC model version for this resource or service model.
62712 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
62713 widget-model-version:
62715 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
62719 $ref: "#/getDefinitions/relationship"
62723 $ref: "#/getDefinitions/metadatum"
62726 Collection of resource instances used to connect a variety of disparate inventory widgets
62731 $ref: "#/getDefinitions/connector"
62732 constrained-element-set:
62734 This is how we would capture constraints defining allowed sets of elements.
62735 ###### Related Nodes
62736 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
62737 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
62738 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
62739 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
62741 - constrained-element-set-uuid
62745 constrained-element-set-uuid:
62753 element-choice-sets:
62756 $ref: "#/getDefinitions/element-choice-set"
62760 $ref: "#/getDefinitions/relationship"
62761 constrained-element-sets:
62763 constrained-element-set:
62766 $ref: "#/getDefinitions/constrained-element-set"
62769 ###### Related Nodes
62770 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
62771 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
62781 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62785 $ref: "#/getDefinitions/relationship"
62791 $ref: "#/getDefinitions/ctag-assignment"
62794 A collection of C tags (vlan tags) grouped for a specific purpose.
62795 ###### Related Nodes
62796 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
62797 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
62798 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
62799 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
62802 - availability-zone-name
62803 - ctag-pool-purpose
62807 description: The Target provider edge router
62808 availability-zone-name:
62810 description: Name of the availability zone
62813 description: Describes what the intended purpose of this pool is.
62816 description: Comma separated list of ctags
62819 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62823 $ref: "#/getDefinitions/relationship"
62829 $ref: "#/getDefinitions/ctag-pool"
62832 customer identifiers to provide linkage back to BSS information.
62833 ###### Related Nodes
62834 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
62835 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
62837 - global-customer-id
62841 global-customer-id:
62843 description: Global customer id used across ECOMP to uniquely identify customer.
62846 description: Subscriber name, an alternate way to retrieve a customer.
62849 description: Subscriber type, a way to provide VID with only the INFRA customers.
62852 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62853 service-subscriptions:
62856 $ref: "#/getDefinitions/service-subscription"
62860 $ref: "#/getDefinitions/relationship"
62863 Collection of customer identifiers to provide linkage back to BSS information.
62868 $ref: "#/getDefinitions/customer"
62876 description: See mis-na-virtualization-platform.yang
62879 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62883 $ref: "#/getDefinitions/relationship"
62889 $ref: "#/getDefinitions/cvlan-tag-entry"
62892 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.
62893 ###### Related Nodes
62894 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62895 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
62902 description: DVS switch name
62905 description: URL used to reach the vcenter
62908 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62912 $ref: "#/getDefinitions/relationship"
62915 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
62920 $ref: "#/getDefinitions/dvs-switch"
62923 Internal map to define the properties of an edge and interpret the map EdgeRules
62939 edge-tag-query-request:
62950 $ref: "#/getDefinitions/start-node-filter"
62951 include-node-filter:
62954 $ref: "#/getDefinitions/include-node-filter"
62958 $ref: "#/getDefinitions/secondary-filter"
62959 edge-tag-query-result:
62961 tagged-inventory-item-list:
62964 $ref: "#/getDefinitions/tagged-inventory-item-list"
62965 element-choice-set:
62967 This is how we would capture constraints defining allowed sets of elements.
62968 ###### Related Nodes
62969 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
62970 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
62971 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
62973 - element-choice-set-uuid
62974 - element-choice-set-name
62976 element-choice-set-uuid:
62978 element-choice-set-name:
62987 $ref: "#/getDefinitions/model-element"
62991 $ref: "#/getDefinitions/relationship"
62992 element-choice-sets:
62994 element-choice-set:
62997 $ref: "#/getDefinitions/element-choice-set"
63000 Metadata for entitlement group.
63001 ###### Related Nodes
63002 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63003 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
63010 description: Unique ID for the entitlement group the resource comes from, should be uuid.
63013 description: Unique ID of an entitlement resource.
63016 description: Concurrency value
63020 $ref: "#/getDefinitions/relationship"
63023 Entitlements, keyed by group-uuid and resource-uuid, related to license management
63028 $ref: "#/getDefinitions/entitlement"
63031 Persist EMS address information used by EMS driver.
63032 ###### Related Nodes
63033 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
63034 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
63040 description: Unique ID of EMS.
63043 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63044 esr-system-info-list:
63046 $ref: "#/getDefinitions/esr-system-info-list"
63049 $ref: "#/getDefinitions/relationship-list"
63055 $ref: "#/getDefinitions/esr-ems"
63058 Persist common address information of external systems.
63059 ###### Related Nodes
63060 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
63061 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
63062 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
63063 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
63065 - esr-system-info-id
63070 esr-system-info-id:
63072 description: Unique ID of esr system info.
63075 description: name of external system.
63078 description: type of external systems.
63081 description: vendor of external systems.
63084 description: version of external systems.
63087 description: url used to access external systems.
63090 description: username used to access external systems.
63093 description: password used to access external systems.
63096 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
63099 description: protocol of third party SDNC, for example netconf/snmp.
63102 description: ca file content if enabled ssl on auth-url.
63105 description: Whether to verify VIM's certificate.
63108 description: service IP of ftp server.
63111 description: service port of ftp server.
63114 description: domain info for authentication.
63117 description: default tenant of VIM.
63120 description: ftp passive mode or not.
63123 description: resource or performance data file path.
63126 description: the status of external system.
63129 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63133 $ref: "#/getDefinitions/relationship"
63134 esr-system-info-list:
63136 Collection of persistent block-level external system auth info.
63141 $ref: "#/getDefinitions/esr-system-info"
63142 esr-thirdparty-sdnc:
63144 Persist SDNC address information used by ONAP SDNC.
63145 ###### Related Nodes
63146 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
63147 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
63148 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
63150 - thirdparty-sdnc-id
63152 thirdparty-sdnc-id:
63154 description: Unique ID of SDNC.
63157 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
63160 description: password used to access SDNC server.
63163 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63164 esr-system-info-list:
63166 $ref: "#/getDefinitions/esr-system-info-list"
63169 $ref: "#/getDefinitions/relationship-list"
63170 esr-thirdparty-sdnc-list:
63172 esr-thirdparty-sdnc:
63175 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
63178 Persist VNFM address information used by VF-C.
63179 ###### Related Nodes
63180 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
63181 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
63187 description: Unique ID of VNFM.
63190 description: indecate the VIM to deploy VNF.
63193 description: certificate url of VNFM.
63196 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63197 esr-system-info-list:
63199 $ref: "#/getDefinitions/esr-system-info-list"
63202 $ref: "#/getDefinitions/relationship-list"
63208 $ref: "#/getDefinitions/esr-vnfm"
63211 evc object is an optional child object of the Configuration object.
63212 ###### Related Nodes
63213 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
63219 description: Unique/key field for the evc object
63220 forwarding-path-topology:
63222 description: Point-to-Point, Multi-Point
63225 description: Commited Information Rate
63228 description: CIR units
63229 connection-diversity-group-id:
63231 description: Diversity Group ID
63234 description: formerly Performance Group
63235 esp-evc-circuit-id:
63237 description: EVC Circuit ID of ESP EVC
63240 description: Committed Information Rate (For ESP)
63243 description: CIR units (For ESP)
63246 description: Identifies ESP
63247 collector-pop-clli:
63249 description: Collector POP CLLI (from the hostname of the access pnf)
63250 inter-connect-type-ingress:
63252 description: Interconnect type on ingress side of EVC.
63253 tagmode-access-ingress:
63255 description: tagode for collector side of EVC
63256 tagmode-access-egress:
63258 description: tagMode for network side of EVC
63262 $ref: "#/getDefinitions/relationship"
63265 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63271 $ref: "#/getDefinitions/evc"
63274 Namespace for external system.
63278 $ref: "#/getDefinitions/esr-ems-list"
63281 $ref: "#/getDefinitions/esr-vnfm-list"
63282 esr-thirdparty-sdnc-list:
63284 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
63287 Extra properties for inventory item for response list
63292 $ref: "#/getDefinitions/extra-property"
63302 ###### Related Nodes
63303 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63304 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
63305 - FLAVOR cannot be deleted if linked to VSERVER
63313 description: Flavor id, expected to be unique across cloud-region.
63316 description: Flavor name
63320 description: Number of CPUs
63324 description: Amount of memory
63328 description: Disk space
63332 description: Amount of ephemeral disk space
63335 description: amount of swap space allocation
63338 description: whether flavor is available to all users or private to the tenant it was created in.
63341 description: URL to endpoint where AAI can get more details
63344 description: Boolean as to whether this flavor is no longer enabled
63347 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63351 $ref: "#/getDefinitions/relationship"
63354 Collection of openstack flavors.
63359 $ref: "#/getDefinitions/flavor"
63362 Entity describing a sequenced segment of forwarding path
63363 ###### Related Nodes
63364 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
63365 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
63366 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
63367 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
63368 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
63369 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
63376 description: Unique ID of this segmentation
63379 description: ingress, intermediate, egress
63383 $ref: "#/getDefinitions/relationship"
63386 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63389 forwarder object is an optional child object of the Configuration object.
63390 ###### Related Nodes
63391 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
63397 description: Key for forwarder-evc object
63400 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
63403 description: Internal VLAN.
63406 description: SVLAN value for ingress of egress forwarder.
63409 description: CVLAN value for ingress of egress forwarder.
63413 $ref: "#/getDefinitions/relationship"
63416 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63422 $ref: "#/getDefinitions/forwarder-evc"
63428 $ref: "#/getDefinitions/forwarder"
63431 Entity that describes the sequenced forwarding path between interfaces of services or resources
63432 ###### Related Nodes
63433 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
63434 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
63435 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
63436 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
63437 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
63439 - forwarding-path-id
63440 - forwarding-path-name
63442 forwarding-path-id:
63444 description: Unique ID of this FP
63445 forwarding-path-name:
63447 description: Name of the FP
63451 $ref: "#/getDefinitions/relationship"
63454 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63457 description: the self link for this FP
63461 $ref: "#/getDefinitions/forwarder"
63467 $ref: "#/getDefinitions/forwarding-path"
63470 General purpose VNF
63471 ###### Related Nodes
63472 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
63473 - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
63474 - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
63475 - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
63476 - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63477 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
63478 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
63479 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
63480 - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
63481 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
63482 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
63483 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
63484 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
63485 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
63486 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
63487 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63488 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63489 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63490 - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63491 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63492 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
63493 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
63494 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
63495 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63496 - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
63497 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
63498 - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
63499 - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
63500 - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
63507 - vnf-discriptor-name
63510 - is-closed-loop-disabled
63514 description: Unique id of VNF. This is unique across the graph.
63517 description: vnf instance id.
63520 description: Name of VNF.
63523 description: Alternate name of VNF.
63526 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.
63529 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
63530 regional-resource-zone:
63532 description: Regional way of organizing pservers, source of truth should define values
63535 description: Trigger for operational monitoring of this resource by Service Assurance systems.
63536 operational-status:
63538 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
63541 description: OBSOLETE - do not use
63544 description: Client should send valid enumerated value
63545 orchestration-status:
63547 description: Orchestration status of this VNF, used by MSO.
63550 vnf-discriptor-name:
63552 description: vnf discriptor name
63555 description: job id corresponding to vnf
63558 description: Heat stack id corresponding to this instance, managed by MSO
63561 description: Corresponds to the SDN-C catalog id used to configure this VCE
63564 description: identifier of managed by ATT or customer
63567 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
63568 ipv4-loopback0-address:
63570 description: v4 Loopback0 address
63573 description: v6 Loopback address
63574 management-v6-address:
63576 description: v6 management address
63580 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
63583 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
63587 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
63590 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
63594 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
63597 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
63601 description: number of associated SHD in vnf.
63605 description: number of vms in vnf.
63609 description: number of network in vnf.
63612 is-closed-loop-disabled:
63616 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63619 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
63620 encrypted-access-flag:
63622 description: indicates whether generic-vnf access uses SSH
63623 entitlement-assignment-group-uuid:
63625 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
63626 entitlement-resource-uuid:
63628 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
63629 license-assignment-group-uuid:
63631 description: UUID of the license assignment group. OBSOLETE - See child relationships.
63634 description: UUID of the actual license resource. OBSOLETE - See child relationships.
63635 model-invariant-id:
63637 description: the ASDC model id for this resource or service model.
63640 description: the ASDC model version for this resource or service model.
63641 persona-model-version:
63643 description: the ASDC model version for this resource or service model.
63644 model-customization-id:
63646 description: captures the id of all the configuration used to customize the resource for the service.
63649 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
63650 widget-model-version:
63652 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
63655 description: as-number of the VNF
63656 regional-resource-subzone:
63658 description: represents sub zone of the rr plane
63661 description: Generic description of the type of NF
63664 description: English description of Network function that the specific VNF deployment is providing
63667 description: role in the network that this model will be providing
63670 description: string assigned to this model used for naming purposes
63673 description: Path to the controller object.
63674 ipv4-oam-gateway-address:
63676 description: Gateway address
63677 ipv4-oam-gateway-address-prefix-length:
63680 description: Prefix length for oam-address
63684 description: Temporary location for S-TAG to get to VCE
63687 description: Network Management profile of this VNF
63691 $ref: "#/getDefinitions/relationship"
63695 $ref: "#/getDefinitions/l-interface"
63699 $ref: "#/getDefinitions/lag-interface"
63703 $ref: "#/getDefinitions/vf-module"
63707 $ref: "#/getDefinitions/license"
63711 $ref: "#/getDefinitions/entitlement"
63719 $ref: "#/getDefinitions/generic-vnf"
63722 Openstack group-assignment used to store exclusivity groups (EG).
63723 ###### Related Nodes
63724 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63725 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
63726 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
63734 description: Group id, expected to be unique across cloud-region.
63737 description: Group type - the type of group this instance refers to
63740 description: Group name - name assigned to the group
63743 description: Group description - description of the group
63746 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63750 $ref: "#/getDefinitions/relationship"
63753 Collection of openstack group assignments
63758 $ref: "#/getDefinitions/group-assignment"
63761 ###### Related Nodes
63762 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
63770 description: host-route id
63773 description: subnet prefix
63776 description: Could be ip-address, hostname, or service-instance
63779 description: Should be ip-address, hostname, or service-instance to match next-hop
63782 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63786 $ref: "#/getDefinitions/relationship"
63792 $ref: "#/getDefinitions/host-route"
63795 Collection of HPA Capabilities
63800 $ref: "#/getDefinitions/hpa-capability"
63803 Represents a HPA capability
63804 ###### Related Nodes
63805 - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
63806 - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63807 - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
63808 - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
63810 - hpa-capability-id
63815 description: UUID to uniquely identify a HPA capability
63818 description: Name of the HPACapability
63821 description: HPA schema version
63824 description: Hardware architecture
63827 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63831 $ref: "#/getDefinitions/relationship"
63832 hpa-feature-attributes:
63835 $ref: "#/getDefinitions/hpa-feature-attributes"
63836 hpa-feature-attributes:
63838 HPA Capability Feature attributes
63839 ###### Related Nodes
63840 - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
63842 - hpa-attribute-key
63846 description: name of the specific HPA attribute
63847 hpa-attribute-value:
63849 description: JSON string specifying the value, unit and type of the specific HPA attribute
63852 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63856 $ref: "#/getDefinitions/relationship"
63860 ###### Related Nodes
63861 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63862 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
63863 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
63864 - IMAGE cannot be deleted if linked to VSERVER
63865 - IMAGE is DELETED when these are DELETED METADATUM
63875 description: Image id, expected to be unique across cloud region
63878 description: Image name
63879 image-architecture:
63881 description: Operating system architecture.
63884 description: The common name of the operating system distribution in lowercase
63887 description: The operating system version as specified by the distributor.
63890 description: The application that the image instantiates.
63891 application-vendor:
63893 description: The vendor of the application.
63894 application-version:
63896 description: The version of the application.
63899 description: URL to endpoint where AAI can get more details
63902 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63906 $ref: "#/getDefinitions/relationship"
63910 $ref: "#/getDefinitions/metadatum"
63913 Collectio of Openstack images.
63918 $ref: "#/getDefinitions/image"
63919 include-node-filter:
63925 InstanceFilter for performing a named-query or model query
63928 InstanceFilters for performing a named-query or model query
63933 $ref: "#/getDefinitions/instance-filter"
63936 General mechanism for grouping instances
63937 ###### Related Nodes
63938 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
63939 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63940 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63941 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
63942 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
63943 - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63944 - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63945 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63946 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63947 - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63948 - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63949 - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63951 - instance-group-role
63952 - model-invariant-id
63958 instance-group-role:
63960 description: role of the instance group.
63961 model-invariant-id:
63963 description: ASDC model id for this resource or service model.
63966 description: ASDC model version uid for this resource model.
63969 description: Instance Group ID, UUID assigned to this instance.
63972 description: Descriptive text to help identify the usage of this instance-group
63975 description: Only valid value today is lower case ha for high availability
63978 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
63981 description: Concurrency value
63985 $ref: "#/getDefinitions/relationship"
63988 Collection of openstack route table references
63993 $ref: "#/getDefinitions/instance-group"
63998 $ref: "#/getDefinitions/search"
64001 $ref: "#/getDefinitions/actions"
64002 cloud-infrastructure:
64004 $ref: "#/getDefinitions/cloud-infrastructure"
64007 $ref: "#/getDefinitions/external-system"
64010 $ref: "#/getDefinitions/business"
64011 service-design-and-creation:
64013 $ref: "#/getDefinitions/service-design-and-creation"
64016 $ref: "#/getDefinitions/network"
64019 $ref: "#/getDefinitions/aai-internal"
64023 $ref: "#/getDefinitions/aai-internal"
64026 inventory-item-type:
64028 inventory-item-link:
64030 inventory-item-data:
64033 $ref: "#/getDefinitions/inventory-item-data"
64034 tagged-inventory-item-list:
64037 $ref: "#/getDefinitions/tagged-inventory-item-list"
64038 inventory-item-data:
64044 inventory-response-item:
64046 Inventory item for response list
64052 $ref: "#/getDefinitions/extra-properties"
64053 inventory-response-items:
64055 $ref: "#/getDefinitions/inventory-response-items"
64056 inventory-response-items:
64058 Container for inventory items in response list
64060 inventory-response-item:
64063 $ref: "#/getDefinitions/inventory-response-item"
64064 ipsec-configuration:
64066 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
64067 ###### Related Nodes
64068 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
64069 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
64070 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
64072 - ipsec-configuration-id
64074 ipsec-configuration-id:
64076 description: UUID of this configuration
64077 requested-vig-address-type:
64079 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
64080 requested-encryption-strength:
64082 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
64083 requested-dmz-type:
64085 description: ATT can offer a shared DMZ or a DMZ specific to a customer
64086 shared-dmz-network-address:
64088 description: Network address of shared DMZ
64089 requested-customer-name:
64091 description: If the DMZ is a custom DMZ, this field will indicate the customer information
64094 description: can be 1 or 2
64095 ikev1-authentication:
64097 description: Contains values like md5, sha1, sha256, sha384
64100 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
64103 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
64106 description: Group name defined in VIG for clients using aggressive mode
64109 description: pre-shared key for the above group name
64112 description: Lifetime for IKEv1 SA
64113 ipsec-authentication:
64115 description: md5, sha1, sha256, sha384
64118 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
64121 description: Life time for IPSec SA
64124 description: enable PFS or not
64127 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
64128 xauth-user-password:
64130 description: Encrypted using the Juniper $9$ algorithm
64133 description: The time between DPD probe
64136 description: Maximum number of DPD before claiming the tunnel is down
64139 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64143 $ref: "#/getDefinitions/relationship"
64147 $ref: "#/getDefinitions/vig-server"
64148 ipsec-configurations:
64150 ipsec-configuration:
64153 $ref: "#/getDefinitions/ipsec-configuration"
64162 Logical interfaces, e.g., a vnic.
64163 ###### Related Nodes
64164 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64165 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
64166 - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64167 - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64168 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
64169 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
64170 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
64171 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
64172 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
64173 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64174 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64175 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
64176 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
64177 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64178 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
64179 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
64188 description: Name given to the interface
64191 description: E.g., CUSTOMER, UPLINK, etc.
64194 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
64197 description: URL to endpoint where AAI can get more details
64200 description: ID of interface
64203 description: MAC address for the interface
64206 description: Name of the network
64209 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
64210 interface-description:
64212 description: Human friendly text regarding this interface.
64217 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64222 description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
64225 allowed-address-pairs:
64227 description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
64231 $ref: "#/getDefinitions/vlan"
64235 $ref: "#/getDefinitions/sriov-vf"
64239 $ref: "#/getDefinitions/l-interface"
64243 $ref: "#/getDefinitions/relationship"
64244 l3-interface-ipv4-address-list:
64247 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
64248 l3-interface-ipv6-address-list:
64251 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
64254 Collection of logical interfaces.
64259 $ref: "#/getDefinitions/l-interface"
64260 l3-interface-ipv4-address-list:
64263 ###### Related Nodes
64264 - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
64265 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
64266 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
64267 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64268 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
64269 - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
64271 - l3-interface-ipv4-address
64273 l3-interface-ipv4-address:
64275 description: IP address
64276 l3-interface-ipv4-prefix-length:
64279 description: Prefix length, 32 for single address
64283 description: Inner VLAN tag
64287 description: Outer VLAN tag
64290 description: Indicator of fixed or floating address
64293 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64294 neutron-network-id:
64296 description: Neutron network id of the interface that address belongs to
64299 description: Neutron id of subnet that address belongs to
64303 $ref: "#/getDefinitions/relationship"
64304 l3-interface-ipv6-address-list:
64307 ###### Related Nodes
64308 - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
64309 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
64310 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
64311 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64312 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
64313 - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
64315 - l3-interface-ipv6-address
64317 l3-interface-ipv6-address:
64319 description: IP address
64320 l3-interface-ipv6-prefix-length:
64323 description: Prefix length, 128 for single address
64327 description: Inner VLAN tag
64331 description: Outer VLAN tag
64334 description: Indicator of fixed or floating address
64337 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64338 neutron-network-id:
64340 description: Neutron network id of the interface that address belongs to
64343 description: Neutron id of subnet that address belongs to
64347 $ref: "#/getDefinitions/relationship"
64350 Generic network definition
64351 ###### Related Nodes
64352 - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64353 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
64354 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
64355 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
64356 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
64357 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64358 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64359 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64360 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
64361 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
64362 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
64363 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
64364 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
64365 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
64366 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64367 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
64368 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
64373 - is-provider-network
64374 - is-shared-network
64375 - is-external-network
64379 description: Network ID, should be uuid. Unique across A&AI.
64382 description: Name of the network, governed by some naming convention..
64385 description: Type of the network - who defines these values?
64388 description: Role the network plans - who defines these values?
64389 network-technology:
64391 description: Network technology - who defines these values?
64392 neutron-network-id:
64394 description: Neutron network id of this Interface
64399 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
64400 network-role-instance:
64403 description: network role instance
64406 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64407 orchestration-status:
64409 description: Orchestration status of this VNF, mastered by MSO
64412 description: Heat stack id corresponding to this instance, managed by MSO
64415 description: Corresponds to the SDN-C catalog id used to configure this VCE
64416 contrail-network-fqdn:
64418 description: Contrail FQDN for the network
64419 model-invariant-id:
64421 description: the ASDC model id for this resource or service model.
64424 description: the ASDC model version for this resource or service model.
64425 persona-model-version:
64427 description: the ASDC model version for this resource or service model.
64428 model-customization-id:
64430 description: captures the id of all the configuration used to customize the resource for the service.
64433 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
64434 widget-model-version:
64436 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
64437 physical-network-name:
64439 description: Name associated with the physical network.
64440 is-provider-network:
64444 is-external-network:
64448 description: Path to the controller object.
64449 operational-status:
64451 description: Indicator for whether the resource is considered operational.
64455 $ref: "#/getDefinitions/subnet"
64459 $ref: "#/getDefinitions/ctag-assignment"
64460 segmentation-assignments:
64463 $ref: "#/getDefinitions/segmentation-assignment"
64467 $ref: "#/getDefinitions/relationship"
64468 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
64474 $ref: "#/getDefinitions/l3-network"
64477 Link aggregate interface
64478 ###### Related Nodes
64479 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64480 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
64481 - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64482 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
64483 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
64484 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
64485 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
64486 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
64487 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
64488 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
64495 description: Name that identifies the link aggregate interface
64496 interface-description:
64498 description: Human friendly text regarding this interface.
64501 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64504 description: Captures the numeric part of the speed
64507 description: Captures the units corresponding to the speed
64510 description: ID of interface
64513 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
64516 description: Trigger for operational monitoring of this resource by Service Assurance systems.
64522 $ref: "#/getDefinitions/relationship"
64526 $ref: "#/getDefinitions/l-interface"
64529 Collection of link aggregate interfaces.
64534 $ref: "#/getDefinitions/lag-interface"
64537 LAG links can connect lag-interfaces
64538 ###### Related Nodes
64539 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
64540 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
64546 description: Alphabetical concatenation of lag-interface names
64549 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64553 $ref: "#/getDefinitions/relationship"
64556 Collection of link aggregation connections
64561 $ref: "#/getDefinitions/lag-link"
64564 Metadata for license group.
64565 ###### Related Nodes
64566 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64567 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
64574 description: Unique ID for the license group the resource belongs to, should be uuid.
64577 description: Unique ID of a license resource.
64580 description: Concurrency value
64584 $ref: "#/getDefinitions/relationship"
64587 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
64592 $ref: "#/getDefinitions/license"
64595 describes a line-of-business
64596 ###### Related Nodes
64597 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
64599 - line-of-business-name
64601 line-of-business-name:
64603 description: Name of the line-of-business (product)
64606 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64610 $ref: "#/getDefinitions/relationship"
64613 Collection of lines-of-business
64618 $ref: "#/getDefinitions/line-of-business"
64621 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
64622 ###### Related Nodes
64623 - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
64624 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
64625 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
64626 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64627 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
64628 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
64629 - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
64630 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
64631 - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
64632 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64633 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
64634 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
64635 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
64636 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64637 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64645 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
64650 description: Type of logical link, e.g., evc
64653 description: Captures the numeric part of the speed
64656 description: Captures the units corresponding to the speed
64659 description: v4, v6, or ds for dual stack
64662 description: For example, static or BGP
64665 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64666 model-invariant-id:
64668 description: the ASDC model id for this resource or service model.
64671 description: the ASDC model version for this resource or service model.
64672 persona-model-version:
64674 description: the ASDC model version for this resource or service model.
64677 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
64678 widget-model-version:
64680 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
64681 operational-status:
64683 description: Indication of operational status of the logical link.
64686 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
64689 description: Indication of the network use of the logical link.
64692 description: Alias or alternate name (CLCI or D1 name).
64695 description: UUID of the logical-link, SDNC generates this.
64698 description: Circuit id
64701 description: Reason for this entity, role it is playing
64705 $ref: "#/getDefinitions/relationship"
64708 Collection of logical connections
64713 $ref: "#/getDefinitions/logical-link"
64716 Collection of metadatum (key/value pairs)
64721 $ref: "#/getDefinitions/metadatum"
64725 ###### Related Nodes
64726 - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
64727 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
64728 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
64729 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
64730 - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
64741 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64744 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
64745 ###### Related Nodes
64746 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
64747 - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
64748 - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
64749 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
64750 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
64751 - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
64752 - MODEL is DELETED when these are DELETED MODEL-VER
64754 - model-invariant-id
64757 model-invariant-id:
64759 description: Unique identifier corresponding to the main definition of a model in ASDC
64762 description: Type of the model, e.g., service, resource, widget, etc.
64765 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64769 $ref: "#/getDefinitions/model-ver"
64773 $ref: "#/getDefinitions/relationship"
64774 model-and-named-query-search:
64776 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
64780 $ref: "#/getDefinitions/query-parameters"
64783 $ref: "#/getDefinitions/instance-filters"
64786 $ref: "#/getDefinitions/secondary-filts"
64789 secondary-filter-cut-point:
64793 This is how we would capture constraints defining allowed sets of elements.
64794 ###### Related Nodes
64795 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64796 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
64797 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
64799 - model-constraint-uuid
64800 - constrained-element-set-uuid-to-replace
64802 model-constraint-uuid:
64804 constrained-element-set-uuid-to-replace:
64806 constrained-element-sets:
64809 $ref: "#/getDefinitions/constrained-element-set"
64812 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64818 $ref: "#/getDefinitions/model-constraint"
64821 Defines how other models combine to make up a higher-level model.
64822 ###### Related Nodes
64823 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
64824 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64825 - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
64826 - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
64827 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64828 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64829 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64830 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
64832 - model-element-uuid
64833 - new-data-del-flag
64836 model-element-uuid:
64840 description: Indicates whether this element was created as part of instantiation from this model
64843 description: How many of this type of element are required/allowed
64848 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64852 $ref: "#/getDefinitions/model-element"
64853 description: Defines how other models combine to make up a higher-level model
64857 $ref: "#/getDefinitions/model-constraint"
64858 description: Describes new constraints on this model element that are not part of that model's definition
64862 $ref: "#/getDefinitions/relationship"
64868 $ref: "#/getDefinitions/model-element"
64871 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
64872 ###### Related Nodes
64873 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
64874 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
64875 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
64876 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
64877 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
64878 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
64886 description: Unique identifier corresponding to one version of a model in ASDC
64889 description: Name of the model, which can change from version to version.
64892 description: Version
64895 description: Description
64898 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64902 $ref: "#/getDefinitions/model-element"
64906 $ref: "#/getDefinitions/metadatum"
64910 $ref: "#/getDefinitions/relationship"
64916 $ref: "#/getDefinitions/model-ver"
64919 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
64924 $ref: "#/getDefinitions/model"
64925 multicast-configuration:
64927 ###### Related Nodes
64928 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
64930 - multicast-configuration-id
64931 - multicast-protocol
64934 multicast-configuration-id:
64936 description: Unique id of multicast configuration.
64937 multicast-protocol:
64939 description: protocol of multicast configuration
64942 description: rp type of multicast configuration
64945 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
64949 $ref: "#/getDefinitions/relationship"
64950 multicast-configurations:
64952 multicast configuration of generic-vnf ip-address
64954 multicast-configuration:
64957 $ref: "#/getDefinitions/multicast-configuration"
64963 $ref: "#/getDefinitions/named-query"
64967 ###### Related Nodes
64968 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
64969 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
64970 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
64971 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
64975 - named-query-version
64981 named-query-version:
64983 required-input-param:
64989 named-query-elements:
64992 $ref: "#/getDefinitions/named-query-element"
64996 $ref: "#/getDefinitions/relationship"
64997 named-query-element:
65000 ###### Related Nodes
65001 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
65002 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
65003 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65004 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65005 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65006 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65007 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
65009 - named-query-element-uuid
65011 named-query-element-uuid:
65013 property-collect-list:
65017 property-limit-desc:
65021 named-query-elements:
65024 $ref: "#/getDefinitions/named-query-element"
65028 $ref: "#/getDefinitions/related-lookup"
65029 property-constraints:
65032 $ref: "#/getDefinitions/property-constraint"
65036 $ref: "#/getDefinitions/relationship"
65037 named-query-elements:
65039 named-query-element:
65042 $ref: "#/getDefinitions/named-query-element"
65045 Namespace for network inventory resources.
65050 $ref: "#/getDefinitions/logical-link"
65054 $ref: "#/getDefinitions/site-pair-set"
65058 $ref: "#/getDefinitions/vpn-binding"
65062 $ref: "#/getDefinitions/vpls-pe"
65063 multicast-configurations:
65066 $ref: "#/getDefinitions/multicast-configuration"
65070 $ref: "#/getDefinitions/vce"
65074 $ref: "#/getDefinitions/vnfc"
65078 $ref: "#/getDefinitions/l3-network"
65082 $ref: "#/getDefinitions/network-policy"
65086 $ref: "#/getDefinitions/generic-vnf"
65090 $ref: "#/getDefinitions/lag-link"
65094 $ref: "#/getDefinitions/newvce"
65098 $ref: "#/getDefinitions/pnf"
65102 $ref: "#/getDefinitions/physical-link"
65103 ipsec-configurations:
65106 $ref: "#/getDefinitions/ipsec-configuration"
65107 route-table-references:
65110 $ref: "#/getDefinitions/route-table-reference"
65114 $ref: "#/getDefinitions/instance-group"
65118 $ref: "#/getDefinitions/zone"
65122 $ref: "#/getDefinitions/configurations"
65128 $ref: "#/getDefinitions/network-policy"
65131 ###### Related Nodes
65132 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
65133 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
65135 - network-policy-id
65139 description: UUID representing unique key to this instance
65140 network-policy-fqdn:
65142 description: Contrail FQDN for the policy
65145 description: ID for the openStack Heat instance
65148 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65152 $ref: "#/getDefinitions/relationship"
65155 Network profile populated by SDN-GP for SNMP
65156 ###### Related Nodes
65157 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
65163 description: Unique name of network profile.
65166 description: Encrypted SNMP community string
65169 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65173 $ref: "#/getDefinitions/relationship"
65176 Collection of network profiles
65181 $ref: "#/getDefinitions/network-profile"
65184 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
65185 ###### Related Nodes
65186 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
65187 - NEWVCE is DELETED when these are DELETED L-INTERFACE
65195 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
65198 description: Name of VNF.
65201 description: Alternate name of VNF.
65204 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.
65207 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
65208 operational-status:
65210 description: Indicator for whether the resource is considered operational
65213 description: OBSOLETE - do not use
65216 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
65219 description: Client should send valid enumerated value.
65222 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65223 ipv4-loopback0-address:
65225 description: v4 Loopback0 address
65226 orchestration-status:
65228 description: Orchestration status of this VNF, mastered by MSO.
65231 description: Heat stack id corresponding to this instance, managed by MSO
65234 description: Corresponds to the SDN-C catalog id used to configure this VCE
65238 $ref: "#/getDefinitions/relationship"
65242 $ref: "#/getDefinitions/l-interface"
65245 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
65250 $ref: "#/getDefinitions/newvce"
65251 notification-event:
65255 notification-event-header:
65257 $ref: "#/getDefinitions/notification-event-header"
65258 notification-event-header:
65299 $ref: "#/getDefinitions/key-data"
65304 OAM network, to be deprecated shortly. Do not use for new purposes.
65305 ###### Related Nodes
65306 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
65307 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
65308 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
65316 description: UUID of the network. Unique across a cloud-region
65319 description: Name of the network.
65323 description: cvlan-id
65324 ipv4-oam-gateway-address:
65326 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
65327 ipv4-oam-gateway-address-prefix-length:
65330 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
65333 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65337 $ref: "#/getDefinitions/relationship"
65340 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
65345 $ref: "#/getDefinitions/oam-network"
65346 operational-environment:
65348 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
65349 ###### Related Nodes
65350 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
65351 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
65353 - operational-environment-id
65354 - operational-environment-name
65355 - operational-environment-type
65356 - operational-environment-status
65360 operational-environment-id:
65362 description: UUID of an operational environment
65363 operational-environment-name:
65365 description: Operational Environment name
65366 operational-environment-type:
65368 description: Operational Environment Type.
65369 operational-environment-status:
65371 description: Status
65374 description: Tenant Context.
65377 description: Workload Context.
65380 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65384 $ref: "#/getDefinitions/relationship"
65385 operational-environments:
65387 a logical partition of the cloud which allows to have multiple environments in the production AIC.
65389 operational-environment:
65392 $ref: "#/getDefinitions/operational-environment"
65395 Allows for legacy POST of old-style and new-style models
65397 - model-invariant-id
65398 - model-name-version-id
65404 model-invariant-id:
65406 description: Unique identifier corresponding to the main definition of a model in ASDC
65407 model-name-version-id:
65409 description: Unique identifier corresponding to one version of a model in ASDC
65412 description: Type of the model, e.g., service, resource, widget, etc.
65415 description: Name of the model, which can change from version to version.
65418 description: Invariant unique ID which does not change from version to version
65421 description: Version
65424 description: Description
65427 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65430 $ref: "#/getDefinitions/model-vers"
65433 $ref: "#/getDefinitions/relationship-list"
65436 Collection of owning-entities
65441 $ref: "#/getDefinitions/owning-entity"
65444 describes an owning-entity
65445 ###### Related Nodes
65446 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
65449 - owning-entity-name
65453 description: UUID of an owning entity
65454 owning-entity-name:
65456 description: Owning entity name
65459 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65463 $ref: "#/getDefinitions/relationship"
65466 Physical interface (e.g., nic)
65467 ###### Related Nodes
65468 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
65469 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
65470 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
65471 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
65472 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
65473 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
65474 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
65475 - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
65476 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
65477 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
65484 description: Name that identifies the physical interface
65487 description: Captures the numeric part of the speed
65490 description: Captures the units corresponding to the speed
65493 description: Nature of the services and connectivity on this port.
65494 equipment-identifier:
65496 description: CLEI or other specification for p-interface hardware.
65499 description: Role specification for p-interface hardware.
65502 description: Indicates the physical properties of the interface.
65505 description: Trigger for operational monitoring of this resource by Service Assurance systems.
65508 description: MAC Address of the p-interface.
65511 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65516 description: inventory status
65520 $ref: "#/getDefinitions/relationship"
65524 $ref: "#/getDefinitions/sriov-pf"
65528 $ref: "#/getDefinitions/l-interface"
65531 Collection of physical interfaces.
65536 $ref: "#/getDefinitions/p-interface"
65539 Collection of physical connections, typically between p-interfaces
65540 ###### Related Nodes
65541 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
65547 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
65550 description: Captures the numeric part of the speed
65553 description: Captures the units corresponding to the speed
65556 description: Circuit it
65559 description: Dual access mode (e.g., primary, secondary
65562 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
65563 service-provider-name:
65565 description: Name of the service Provider on this link.
65566 service-provider-bandwidth-up-value:
65569 description: Upstream Bandwidth value agreed with the service provider
65570 service-provider-bandwidth-up-units:
65572 description: Units for the upstream BW value
65573 service-provider-bandwidth-down-value:
65576 description: Downstream Bandwidth value agreed with the service provider
65577 service-provider-bandwidth-down-units:
65579 description: Units for downstream BW value
65582 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65586 $ref: "#/getDefinitions/relationship"
65589 Collection of physical connections, typically between p-interfaces
65594 $ref: "#/getDefinitions/physical-link"
65597 describes a platform
65598 ###### Related Nodes
65599 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
65605 description: Name of the platform
65608 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65612 $ref: "#/getDefinitions/relationship"
65615 Collection of platforms
65620 $ref: "#/getDefinitions/platform"
65623 PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
65624 ###### Related Nodes
65625 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
65626 - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65627 - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
65628 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
65629 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
65630 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
65631 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
65632 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
65633 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
65634 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
65641 description: unique name of Physical Network Function.
65644 description: name of Physical Network Function.
65647 description: source of name2
65650 description: id of pnf
65653 description: Equipment type. Source of truth should define valid values.
65656 description: Equipment vendor. Source of truth should define valid values.
65659 description: Equipment model. Source of truth should define valid values.
65662 description: identifier of managed by ATT or customer
65665 description: ipv4-oam-address with new naming convention for IP addresses
65668 description: sw-version is the version of SW for the hosted application on the PNF.
65673 description: ID of the physical frame (relay rack) where pnf is installed.
65676 description: Serial number of the device
65677 ipaddress-v4-loopback-0:
65679 description: IPV4 Loopback 0 address
65680 ipaddress-v6-loopback-0:
65682 description: IPV6 Loopback 0 address
65685 description: IPV4 AIM address
65688 description: IPV6 AIM address
65691 description: IPV6 OAM address
65694 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
65697 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65700 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
65703 description: Nf Role is the role performed by this instance in the network.
65707 $ref: "#/getDefinitions/relationship"
65711 $ref: "#/getDefinitions/p-interface"
65715 $ref: "#/getDefinitions/lag-interface"
65718 Collection of Physical Network Functions.
65723 $ref: "#/getDefinitions/pnf"
65726 Used to capture the network interfaces of this VCE
65727 ###### Related Nodes
65728 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
65729 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
65730 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
65733 - orchestration-status
65737 description: Unique ID of the interface
65738 neutron-network-id:
65740 description: Neutron network id of this Interface
65741 neutron-network-name:
65743 description: Neutron network name of this Interface
65746 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
65749 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65752 description: Unique ID for port group in vmware
65755 description: Likely to duplicate value of neutron network name
65758 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
65759 orchestration-status:
65761 description: Orchestration status of this VNF, mastered by MSO
65764 description: Heat stack id corresponding to this instance, managed by MSO
65767 description: Corresponds to the SDN-C catalog id used to configure this VCE
65771 $ref: "#/getDefinitions/cvlan-tag-entry"
65775 $ref: "#/getDefinitions/relationship"
65781 $ref: "#/getDefinitions/port-group"
65784 describes the project
65785 ###### Related Nodes
65786 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
65792 description: Name of the project deploying a service
65795 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65799 $ref: "#/getDefinitions/relationship"
65802 Collection of projects
65807 $ref: "#/getDefinitions/project"
65810 Property holder for query properties or instance properties
65816 property-constraint:
65819 ###### Related Nodes
65820 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65822 - property-constraint-uuid
65827 property-constraint-uuid:
65837 property-constraints:
65839 property-constraint:
65842 $ref: "#/getDefinitions/property-constraint"
65845 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
65846 ###### Related Nodes
65847 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
65848 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
65849 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
65850 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
65851 - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
65852 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
65853 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
65854 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
65855 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
65856 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
65857 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
65858 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
65859 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
65866 description: Value from executing hostname on the compute node.
65869 description: PTNII name
65873 description: Number of cpus
65877 description: Disk size, in GBs
65881 description: RAM size, in MBs
65884 description: Equipment type. Source of truth should define valid values.
65887 description: Equipment vendor. Source of truth should define valid values.
65890 description: Equipment model. Source of truth should define valid values.
65893 description: Fully-qualified domain name
65896 description: URL to endpoint where AAI can get more details
65899 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
65902 description: Serial number, may be queried
65903 ipaddress-v4-loopback-0:
65905 description: IPV4 Loopback 0 address
65906 ipaddress-v6-loopback-0:
65908 description: IPV6 Loopback 0 address
65911 description: IPV4 AIM address
65914 description: IPV6 AIM address
65917 description: IPV6 OAM address
65920 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
65923 description: ID of Pserver
65926 description: internet topology of Pserver
65931 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
65934 description: alternative pserver name
65937 description: purpose of pserver
65940 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
65943 description: Indicates who owns and or manages the device.
65946 description: The host profile that defines the configuration of the pserver.
65950 $ref: "#/getDefinitions/relationship"
65954 $ref: "#/getDefinitions/p-interface"
65958 $ref: "#/getDefinitions/lag-interface"
65961 Collection of compute hosts.
65966 $ref: "#/getDefinitions/pserver"
65969 QueryParameters for performing a named-query or model query
65973 $ref: "#/getDefinitions/named-query"
65976 $ref: "#/getDefinitions/overloaded-model"
65980 ###### Related Nodes
65981 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65983 - related-lookup-uuid
65985 - source-node-property
65987 - target-node-property
65989 related-lookup-uuid:
65993 source-node-property:
65997 target-node-property:
65999 property-collect-list:
66006 $ref: "#/getDefinitions/relationship"
66012 $ref: "#/getDefinitions/related-lookup"
66013 related-to-property:
66017 description: Key part of a key/value pair
66020 description: Value part of a key/value pair
66025 description: A keyword provided by A&AI to indicate type of node.
66028 description: URL to the object in A&AI.
66032 $ref: "#/getDefinitions/relationship-data"
66033 related-to-property:
66036 $ref: "#/getDefinitions/related-to-property"
66040 - relationship-value
66044 description: A keyword provided by A&AI to indicate an attribute.
66045 relationship-value:
66047 description: Value of the attribute.
66053 $ref: "#/getDefinitions/relationship"
66054 reserved-prop-names:
66056 Internal map to define some reserved properties of a vertex
66058 last-mod-source-of-truth:
66076 Response container for the results of a named-query or model query
66078 inventory-response-items:
66080 $ref: "#/getDefinitions/inventory-response-items"
66085 description: The specific type of node in the A&AI graph
66088 description: The URL to the specific resource
66089 route-table-reference:
66091 Openstack route table reference.
66092 ###### Related Nodes
66093 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
66095 - route-table-reference-id
66096 - route-table-reference-fqdn
66098 route-table-reference-id:
66100 description: Route Table Reference id, UUID assigned to this instance.
66101 route-table-reference-fqdn:
66103 description: FQDN entry in the route table.
66106 description: Concurrency value
66110 $ref: "#/getDefinitions/relationship"
66111 route-table-references:
66113 Collection of openstack route table references
66115 route-table-reference:
66118 $ref: "#/getDefinitions/route-table-reference"
66121 Route target information
66122 ###### Related Nodes
66123 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
66125 - global-route-target
66126 - route-target-role
66128 global-route-target:
66130 description: Number used to identify an RT, globally unique in the network
66133 description: Role assigned to this route target
66136 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66140 $ref: "#/getDefinitions/relationship"
66143 Collection of route target information
66148 $ref: "#/getDefinitions/route-target"
66151 ###### Related Nodes
66152 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
66153 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
66154 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
66156 - routing-instance-id
66158 routing-instance-id:
66160 description: Unique id of routing instance
66163 description: rpm owner
66166 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66170 $ref: "#/getDefinitions/site-pair"
66174 $ref: "#/getDefinitions/relationship"
66177 set of probes related to generic-vnf routing instance
66182 $ref: "#/getDefinitions/routing-instance"
66187 $ref: "#/getDefinitions/oam-networks"
66188 az-and-dvs-switches:
66191 $ref: "#/getDefinitions/az-and-dvs-switches"
66194 edge-tag-query-result:
66196 $ref: "#/getDefinitions/edge-tag-query-result"
66197 edge-tag-query-request:
66199 $ref: "#/getDefinitions/edge-tag-query-request"
66202 $ref: "#/getDefinitions/search-results"
66205 $ref: "#/getDefinitions/sdn-zone-response"
66211 $ref: "#/getDefinitions/result-data"
66214 SecondaryFilt for performing a named-query or model query
66225 SecondaryFilts for performing a named-query or model query
66230 $ref: "#/getDefinitions/secondary-filt"
66231 segmentation-assignment:
66233 Openstack segmentation assignment.
66234 ###### Related Nodes
66235 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66241 description: Route Table Reference id, UUID assigned to this instance.
66244 description: Concurrency value
66248 $ref: "#/getDefinitions/relationship"
66249 segmentation-assignments:
66251 Collection of openstack segmentation assignments
66253 segmentation-assignment:
66256 $ref: "#/getDefinitions/segmentation-assignment"
66259 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
66262 - service-description
66266 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
66267 service-description:
66269 description: Description of the service
66272 description: URL to endpoint where AAI can get more details
66275 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66278 description: service version
66282 $ref: "#/getDefinitions/relationship"
66283 service-capabilities:
66285 Collection of service capabilities.
66287 service-capability:
66290 $ref: "#/getDefinitions/service-capability"
66291 service-capability:
66293 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
66294 ###### Related Nodes
66295 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
66296 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
66297 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
66304 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
66307 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.
66310 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66314 $ref: "#/getDefinitions/relationship"
66315 service-design-and-creation:
66317 Namespace for objects managed by ASDC
66322 $ref: "#/getDefinitions/vnf-image"
66326 $ref: "#/getDefinitions/service"
66327 service-capabilities:
66330 $ref: "#/getDefinitions/service-capability"
66334 $ref: "#/getDefinitions/model"
66338 $ref: "#/getDefinitions/named-query"
66341 Instance of a service
66342 ###### Related Nodes
66343 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
66344 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
66345 - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
66346 - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
66347 - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
66348 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
66349 - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
66350 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
66351 - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66352 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
66353 - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
66354 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
66355 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
66356 - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
66357 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
66358 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
66359 - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
66360 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
66361 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
66362 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
66363 - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
66364 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
66366 - service-instance-id
66373 service-instance-id:
66375 description: Uniquely identifies this instance of a service
66376 service-instance-name:
66378 description: This field will store a name assigned to the service-instance.
66381 description: String capturing type of service.
66384 description: String capturing the service role.
66385 environment-context:
66387 description: This field will store the environment context assigned to the service-instance.
66390 description: This field will store the workload context assigned to the service-instance.
66393 description: create time of Network Service.
66396 description: last update of Network Service.
66399 description: short description for service-instance.
66400 model-invariant-id:
66402 description: the ASDC model id for this resource or service model.
66405 description: the ASDC model version for this resource or service model.
66406 persona-model-version:
66408 description: the ASDC model version for this resource or service model.
66411 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
66412 widget-model-version:
66414 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
66417 description: Indicates the total bandwidth to be used for this service.
66420 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
66421 bandwidth-down-wan1:
66423 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
66426 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
66427 bandwidth-down-wan2:
66429 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
66432 description: URL customers will use to access the vHN Portal.
66433 service-instance-location-id:
66435 description: An identifier that customers assign to the location where this service is being used.
66438 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66441 description: Path to the controller object.
66442 orchestration-status:
66444 description: Orchestration status of this service.
66448 $ref: "#/getDefinitions/relationship"
66452 $ref: "#/getDefinitions/metadatum"
66453 allotted-resources:
66456 $ref: "#/getDefinitions/allotted-resource"
66459 Collection of service instances
66464 $ref: "#/getDefinitions/service-instance"
66465 service-subscription:
66467 Object that group service instances.
66468 ###### Related Nodes
66469 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
66470 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
66471 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
66472 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
66478 description: Value defined by orchestration to identify this service across ECOMP.
66479 temp-ub-sub-account-id:
66481 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
66484 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66488 $ref: "#/getDefinitions/service-instance"
66492 $ref: "#/getDefinitions/relationship"
66493 service-subscriptions:
66495 Collection of objects that group service instances.
66497 service-subscription:
66500 $ref: "#/getDefinitions/service-subscription"
66503 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
66508 $ref: "#/getDefinitions/service"
66511 ###### Related Nodes
66512 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
66513 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
66514 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
66520 description: unique identifier of probe
66523 description: Prefix address
66526 description: Prefix address
66529 description: ip version, v4, v6
66530 destination-hostname:
66532 description: Hostname of the destination equipment to which SLAs are measured against.
66533 destination-equip-type:
66535 description: The type of destinatination equipment. Could be Router, UCPE, etc.
66538 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66539 classes-of-service:
66542 $ref: "#/getDefinitions/class-of-service"
66546 $ref: "#/getDefinitions/relationship"
66549 Set of instances for probes used to measure service level agreements
66550 ###### Related Nodes
66551 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
66552 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
66553 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
66559 description: Unique id of site pair set.
66562 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66566 $ref: "#/getDefinitions/routing-instance"
66570 $ref: "#/getDefinitions/relationship"
66573 Collection of sets of instances for probes related to generic-vnf
66578 $ref: "#/getDefinitions/site-pair-set"
66586 $ref: "#/getDefinitions/site-pair"
66590 ###### Related Nodes
66591 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66592 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
66598 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
66601 description: Snapshot name
66602 snapshot-architecture:
66604 description: Operating system architecture
66605 snapshot-os-distro:
66607 description: The common name of the operating system distribution in lowercase
66608 snapshot-os-version:
66610 description: The operating system version as specified by the distributor.
66613 description: The application that the image instantiates.
66614 application-vendor:
66616 description: The vendor of the application.
66617 application-version:
66619 description: The version of the application.
66622 description: URL to endpoint where AAI can get more details
66625 description: This field contains the UUID of the previous snapshot (if any).
66628 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66632 $ref: "#/getDefinitions/relationship"
66635 Collection of openstack snapshots
66640 $ref: "#/getDefinitions/snapshot"
66643 SR-IOV Physical Function
66644 ###### Related Nodes
66645 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
66646 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
66652 description: Identifier for the sriov-pf
66655 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66659 $ref: "#/getDefinitions/relationship"
66662 Collection of SR-IOV Physical Functions.
66667 $ref: "#/getDefinitions/sriov-pf"
66670 SR-IOV Virtual Function (not to be confused with virtual network function)
66671 ###### Related Nodes
66672 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
66673 - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
66679 description: PCI ID used to identify the sriov-vf
66682 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
66685 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
66688 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
66689 vf-vlan-anti-spoof-check:
66691 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.
66692 vf-mac-anti-spoof-check:
66694 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.
66697 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
66698 vf-broadcast-allow:
66700 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
66701 vf-unknown-multicast-allow:
66703 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
66704 vf-unknown-unicast-allow:
66706 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
66709 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
66712 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
66715 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66716 neutron-network-id:
66718 description: Neutron network id of the interface
66722 $ref: "#/getDefinitions/relationship"
66725 Collection of SR-IOV Virtual Functions.
66730 $ref: "#/getDefinitions/sriov-vf"
66739 ###### Related Nodes
66740 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66741 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
66742 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
66743 - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
66744 - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
66745 - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
66746 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
66747 - SUBNET is DELETED when these are DELETED HOST-ROUTE
66754 description: Subnet ID, should be UUID.
66757 description: Name associated with the subnet.
66760 description: Neutron id of this subnet
66763 description: gateway ip address
66764 network-start-address:
66766 description: network start address
66769 description: cidr mask
66772 description: ip version
66773 orchestration-status:
66775 description: Orchestration status of this VNF, mastered by MSO
66780 description: the start address reserved for use by dhcp
66783 description: the last address reserved for use by dhcp
66786 description: role of the subnet, referenced when assigning IPs
66787 ip-assignment-direction:
66789 description: ip address assignment direction of the subnet
66792 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66796 description: sequence of the subnet
66800 $ref: "#/getDefinitions/host-route"
66804 $ref: "#/getDefinitions/relationship"
66810 $ref: "#/getDefinitions/subnet"
66811 tagged-inventory-item-list:
66816 $ref: "#/getDefinitions/inventory-item"
66820 ###### Related Nodes
66821 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66822 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
66823 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66824 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
66825 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
66826 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
66827 - TENANT cannot be deleted if linked to VSERVER
66834 description: Unique id relative to the cloud-region.
66837 description: Readable name of tenant
66840 description: This field will store the tenant context.
66843 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66847 $ref: "#/getDefinitions/vserver"
66851 $ref: "#/getDefinitions/relationship"
66854 Collection of openstack tenants.
66859 $ref: "#/getDefinitions/tenant"
66862 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
66863 ###### Related Nodes
66864 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
66867 - bandwidth-up-wan1
66868 - bandwidth-down-wan1
66869 - bandwidth-up-wan2
66870 - bandwidth-down-wan2
66874 description: Allotted Resource id UUID assigned to this instance.
66877 description: The WAN uplink bandwidth for WAN1
66878 bandwidth-down-wan1:
66880 description: The WAN downlink bandwidth for WAN1
66883 description: The WAN uplink bandwidth for WAN2
66884 bandwidth-down-wan2:
66886 description: The WAN downlink bandwidth for WAN2
66889 description: Concurrency value
66893 $ref: "#/getDefinitions/relationship"
66896 This object is used to store the specific tunnel cross connect aspects of an allotted resource
66901 $ref: "#/getDefinitions/tunnel-xconnect"
66904 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
66913 $ref: "#/getDefinitions/update-node-key"
66919 $ref: "#/getDefinitions/action"
66928 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
66929 ###### Related Nodes
66930 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
66931 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
66932 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
66933 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
66934 - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
66935 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
66936 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
66937 - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
66945 description: Unique id of VNF. This is unique across the graph.
66948 description: Name of VNF.
66951 description: Alternate name of VNF.
66954 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.
66957 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
66958 regional-resource-zone:
66960 description: Regional way of organizing pservers, source of truth should define values
66963 description: Trigger for operational monitoring of this resource by Service Assurance systems.
66964 operational-status:
66966 description: Indicator for whether the resource is considered operational
66969 description: OBSOLETE - do not use
66972 description: Network role being played by this VNF
66973 orchestration-status:
66975 description: Orchestration status of this VNF, mastered by MSO
66978 description: Heat stack id corresponding to this instance, managed by MSO
66981 description: Corresponds to the SDN-C catalog id used to configure this VCE
66984 description: Unique ID of VPE connected to this VCE.
66985 v6-vce-wan-address:
66987 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
66990 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
66993 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
66994 ipv4-loopback0-address:
66996 description: Loopback0 address
66997 entitlement-resource-uuid:
66999 description: OBSOLETE - see child relationships
67003 $ref: "#/getDefinitions/port-group"
67007 $ref: "#/getDefinitions/license"
67011 $ref: "#/getDefinitions/entitlement"
67015 $ref: "#/getDefinitions/relationship"
67018 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
67023 $ref: "#/getDefinitions/vce"
67026 a deployment unit of VNFCs
67027 ###### Related Nodes
67028 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
67029 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
67030 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
67031 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
67032 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
67033 - VF-MODULE cannot be deleted if linked to VNFC
67036 - is-base-vf-module
67040 description: Unique ID of vf-module.
67043 description: Name of vf-module
67046 description: Heat stack id corresponding to this instance.
67047 orchestration-status:
67049 description: orchestration status of this vf-module, mastered by MSO
67054 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67055 model-invariant-id:
67057 description: the ASDC model id for this resource or service model.
67060 description: the ASDC model version for this resource or service model.
67061 persona-model-version:
67063 description: the ASDC model version for this resource or service model.
67064 model-customization-id:
67066 description: captures the id of all the configuration used to customize the resource for the service.
67069 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
67070 widget-model-version:
67072 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
67073 contrail-service-instance-fqdn:
67075 description: the Contrail unique ID for a service-instance
67079 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
67082 description: Path to the controller object.
67086 $ref: "#/getDefinitions/relationship"
67089 Collection of vf-modules, a deployment unit of VNFCs
67094 $ref: "#/getDefinitions/vf-module"
67097 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
67098 ###### Related Nodes
67099 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
67105 description: indicates whether the VIG is for AVPN or INTERNET
67108 description: v4 IP of the vig server
67111 description: v6 IP of the vig server
67114 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67118 $ref: "#/getDefinitions/relationship"
67124 $ref: "#/getDefinitions/vig-server"
67125 vip-ipv4-address-list:
67128 ###### Related Nodes
67129 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
67130 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
67131 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
67132 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
67138 description: IP address
67139 vip-ipv4-prefix-length:
67142 description: Prefix length, 32 for single address
67146 description: Inner VLAN tag
67150 description: Outer VLAN tag
67153 description: Indicator of fixed or floating address
67156 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67157 neutron-network-id:
67159 description: Neutron network id of the interface that address belongs to
67162 description: Neutron id of subnet that address belongs to
67166 $ref: "#/getDefinitions/relationship"
67167 vip-ipv6-address-list:
67170 ###### Related Nodes
67171 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
67172 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
67173 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
67174 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
67180 description: IP address
67181 vip-ipv6-prefix-length:
67184 description: Prefix length, 128 for single address
67188 description: Inner VLAN tag
67192 description: Outer VLAN tag
67195 description: Indicator of fixed or floating address
67198 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67199 neutron-network-id:
67201 description: Neutron network id of the interface that address belongs to
67204 description: Neutron id of subnet that address belongs to
67208 $ref: "#/getDefinitions/relationship"
67209 virtual-data-center:
67211 Virtual organization of cloud infrastructure elements in a data center context
67212 ###### Related Nodes
67213 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
67214 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
67215 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
67222 description: Unique ID of the vdc
67225 description: Name of the virtual data center
67228 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67232 $ref: "#/getDefinitions/relationship"
67233 virtual-data-centers:
67235 Virtual organization of cloud infrastructure elements in a data center context
67237 virtual-data-center:
67240 $ref: "#/getDefinitions/virtual-data-center"
67244 ###### Related Nodes
67245 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
67246 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
67247 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
67248 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
67249 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
67250 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
67251 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
67252 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
67253 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
67261 description: String that identifies the interface
67265 description: Inner VLAN tag
67269 description: Outer VLAN tag
67272 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67275 description: Captures the numeric part of the speed
67278 description: Captures the units corresponding to the speed
67281 description: Used to describe (the service associated with) the vlan
67282 backdoor-connection:
67284 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
67287 description: This indicates the customers VPN ID associated with this vlan
67288 orchestration-status:
67290 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
67295 description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
67301 $ref: "#/getDefinitions/relationship"
67302 l3-interface-ipv4-address-list:
67305 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
67306 l3-interface-ipv6-address-list:
67309 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
67315 $ref: "#/getDefinitions/vlan"
67324 description: Unique id of VNF. This is unique across the graph.
67327 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
67328 ###### Related Nodes
67329 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
67330 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
67334 - application-vendor
67338 description: Unique ID of this asset
67341 description: The application that the image instantiates.
67342 application-vendor:
67344 description: The vendor of the application.
67345 application-version:
67347 description: The version of the application.
67350 description: URL to endpoint where AAI can get more details
67353 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67357 $ref: "#/getDefinitions/relationship"
67360 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
67365 $ref: "#/getDefinitions/vnf-image"
67368 ###### Related Nodes
67369 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
67370 - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
67371 - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
67372 - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
67373 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
67374 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
67375 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
67376 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
67377 - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
67383 - is-closed-loop-disabled
67387 description: Unique ID of vnfc.
67390 description: Short code that is used in naming instances of the item being modeled
67393 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
67396 description: prov status of this vnfc
67397 orchestration-status:
67399 description: Orchestration status of this VNF, mastered by APP-C
67400 ipaddress-v4-oam-vip:
67402 description: Oam V4 vip address of this vnfc
67405 is-closed-loop-disabled:
67409 description: Group notation of VNFC
67410 model-invariant-id:
67412 description: the ASDC model id for this resource or service model.
67415 description: the ASDC model version for this resource or service model.
67418 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67422 $ref: "#/getDefinitions/relationship"
67423 l3-interface-ipv4-address-list:
67426 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
67427 l3-interface-ipv6-address-list:
67430 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
67433 virtual network components associated with a vserver from application controller.
67438 $ref: "#/getDefinitions/vnfc"
67441 Ephemeral Block storage volume.
67442 ###### Related Nodes
67443 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
67450 description: Unique ID of block storage volume relative to the vserver.
67453 description: URL to endpoint where AAI can get more details
67456 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67460 $ref: "#/getDefinitions/relationship"
67463 Persistent block-level storage.
67464 ###### Related Nodes
67465 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
67466 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
67467 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
67468 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
67469 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
67472 - volume-group-name
67477 description: Unique ID of volume-group.
67480 description: Name of the volume group.
67483 description: Heat stack id corresponding to this volume-group
67486 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.
67487 orchestration-status:
67489 description: Orchestration status of this volume-group
67490 model-customization-id:
67492 description: captures the id of all the configuration used to customize the resource for the service.
67493 vf-module-model-customization-id:
67495 description: helps relate the volume group to the vf-module whose components will require the volume group
67498 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67502 $ref: "#/getDefinitions/relationship"
67505 Collection of persistent block-level storage.
67510 $ref: "#/getDefinitions/volume-group"
67513 Collection of ephemeral Block storage volumes.
67518 $ref: "#/getDefinitions/volume"
67521 VPLS Provider Edge routers.
67522 ###### Related Nodes
67523 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
67524 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
67525 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
67526 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
67527 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
67535 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
67538 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
67541 description: Client should send valid enumerated value, e.g., VPLS-PE.
67545 description: Temporary location for stag to get to VCE
67548 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67552 $ref: "#/getDefinitions/relationship"
67556 $ref: "#/getDefinitions/p-interface"
67560 $ref: "#/getDefinitions/lag-interface"
67563 Collection of VPLS Provider Edge routers
67568 $ref: "#/getDefinitions/vpls-pe"
67572 ###### Related Nodes
67573 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
67574 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
67575 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
67576 - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
67577 - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
67578 - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
67585 description: VPN ID, globally unique within A&AI
67588 description: VPN Name
67591 description: the platform associated with the VPN example AVPN, Mobility
67594 description: Type of the vpn, should be taken from enumerated/valid values
67597 description: region of customer vpn
67600 description: id for this customer vpn
67601 route-distinguisher:
67603 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
67606 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67610 $ref: "#/getDefinitions/route-target"
67614 $ref: "#/getDefinitions/relationship"
67615 description: l3-networks relate to vpn-bindings
67621 $ref: "#/getDefinitions/vpn-binding"
67624 Virtual Servers, aka virtual machine or VM.
67625 ###### Related Nodes
67626 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
67627 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
67628 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
67629 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
67630 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
67631 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
67632 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
67633 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
67634 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
67635 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
67636 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
67637 - VSERVER is DELETED when these are DELETED L-INTERFACE
67638 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
67644 - is-closed-loop-disabled
67648 description: Unique identifier for this vserver relative to its tenant
67651 description: Name of vserver
67654 description: Alternative name of vserver
67657 description: Trigger for operational monitoring of this resource by Service Assurance systems.
67660 description: URL to endpoint where AAI can get more details
67663 is-closed-loop-disabled:
67667 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
67671 $ref: "#/getDefinitions/volume"
67675 $ref: "#/getDefinitions/relationship"
67679 $ref: "#/getDefinitions/l-interface"
67682 Collection of virtual Servers, aka virtual machines or VMs.
67687 $ref: "#/getDefinitions/vserver"
67690 A zone is a grouping of assets in a location homing to the same connections into the CBB
67691 ###### Related Nodes
67692 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
67693 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67694 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67695 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67696 - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67705 description: Code assigned by AIC to the zone
67708 description: English name associated with the zone
67711 description: Design of zone [Medium/Large?]
67714 description: Context of zone [production/test]
67717 description: Status of a zone.
67720 description: Concurrency value
67724 $ref: "#/getDefinitions/relationship"
67727 Collection of zones
67732 $ref: "#/getDefinitions/zone"